Cisco-IOS-XR-man-ipsla-cfg API API Reference

API generated from Cisco-IOS-XR-man-ipsla-cfg@2015-11-09.yang

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

IPSLA - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/

Update operation of resource: ipsla

ipsla_schema

ipslabody object

Request Content-Types: application/json
Request Example
{
  : {
IPSLA configurationPUTPOSTDELETEGET
    : {
Provider Edge(PE) discovery configurationPUTPOSTDELETEGET
      : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
        
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

      }
    },
    : {
IPSLA Operation configurationPUTPOSTDELETEGET
      : {
Reaction trigger configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Reaction condition specificationPUTPOSTDELETEGET
              : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on round trip time threshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on error verfication violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              }
            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Operation type specificationPUTPOSTDELETEGET
              : {
UDPEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"verify-data": "null", Check each IPSLA response for corruption

                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"dest-port": "string", Port number on target device

                
"control-disable": "null", Disable control packets

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"source-port": "string", Port number on source device

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                }
              },
              : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance
                : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                  
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
                : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                  
"node8": "string", IPv4 address of the intermediate node

                  
"node1": "string", IPv4 address of the intermediate node

                  
"node3": "string", IPv4 address of the intermediate node

                  
"node2": "string", IPv4 address of the intermediate node

                  
"node5": "string", IPv4 address of the intermediate node

                  
"node4": "string", IPv4 address of the intermediate node

                  
"node7": "string", IPv4 address of the intermediate node

                  
"node6": "string" IPv4 address of the intermediate node

                },
                
"dest-address": "string" Enter IPv4 address of the destination device

              },
              : {
UDPJitter Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"verify-data": "null", Check each IPSLA response for corruption

                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance
                : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                  
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"control-disable": "null", Disable control packets

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"source-port": "string", Port number on source device

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                
"dest-port": "string" Port number on target device

              },
              : {
ICMPEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"dest-address": "string", Enter IPv4 address of the destination device

                
"source-address-v6": "string", Enter IPv6 address of the source device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                }
              },
              : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                    : {
Target FEC address with maskPUTPOSTDELETEGET
                      
"mask": "string", IP netmask for target

                      
"address": "string" No description

                    }
                  },
                  : {
Traffic engineering targetPUTPOSTDELETEGET
                    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                  }
                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"create": "null", Create MPLSLM instance with specified type

                
"tag": "string", Add a tag for this MPLSLM instance

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                },
                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              },
              : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

                  
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                  
"node8": "string", IPv4 address of the intermediate node

                  
"node1": "string", IPv4 address of the intermediate node

                  
"node3": "string", IPv4 address of the intermediate node

                  
"node2": "string", IPv4 address of the intermediate node

                  
"node5": "string", IPv4 address of the intermediate node

                  
"node4": "string", IPv4 address of the intermediate node

                  
"node7": "string", IPv4 address of the intermediate node

                  
"node6": "string" IPv4 address of the intermediate node

                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string", Choose type of data to be stored in history\nbuffer

                  
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

                }
              },
              : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                  : {
Pseudowire targetPUTPOSTDELETEGET
                    : {
Target addressPUTPOSTDELETEGET
                      
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                      
"address": "string" No description

                    }
                  },
                  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                    : {
Target FEC address with maskPUTPOSTDELETEGET
                      
"mask": "string", IP netmask for target

                      
"address": "string" No description

                    }
                  },
                  : {
Traffic engineering targetPUTPOSTDELETEGET
                    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                  }
                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                },
                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              }
            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM schedule configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

            
"life": "string", Length of the time to execute (default 3600\nseconds)

            
"recurring": "null", probe to be scheduled automatically every day
            : {
Start time of MPLSLM instancePUTPOSTDELETEGET
              
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

              
"month": "string", Month of the year (optional. Default current\nmonth)

              
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

              
"schedule-type": "string", Type of schedule

              
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

              
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

              
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      }
    },
    : {
MPLS LSP Monitor(MPLSLM) configurationPUTPOSTDELETEGET
      : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Reaction condition specificationPUTPOSTDELETEGET
              : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              }
            },
            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      },
      : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Operation type specificationPUTPOSTDELETEGET
              : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                },
                : {
Scanning parameters configurationPUTPOSTDELETEGET
                  
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"create": "null", Create MPLSLM instance with specified type

                
"accesslist": "string", Apply access list to filter PE addresses

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"tag": "string", Add a tag for this MPLSLM instance

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              },
              : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                },
                : {
Path discover configurationPUTPOSTDELETEGET
                  : {
Path parameters configurationPUTPOSTDELETEGET
                    : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
                      
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                      
"type": "string" Configure IPSLA Responder port type

                    },
                    
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                  },
                  
"create": "null", Create MPLSLM instance with specified type
                  : {
Session parameters configurationPUTPOSTDELETEGET
                    
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

                    
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                  },
                  
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
                  : {
Echo parameters configurationPUTPOSTDELETEGET
                    
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
                    : {
Downstream map multipath settingsPUTPOSTDELETEGET
                      
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

                    },
                    
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                  }
                },
                : {
Scanning parameters configurationPUTPOSTDELETEGET
                  
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"accesslist": "string", Apply access list to filter PE addresses

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"tag": "string", Add a tag for this MPLSLM instance

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              }
            },
            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM schedule configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
            : {
Start time of MPLSLM instancePUTPOSTDELETEGET
              
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

              
"month": "string", Month of the year (optional. Default current\nmonth)

              
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

              
"schedule-type": "string", Type of schedule

              
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

              
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

              
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

            },
            
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"

            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      }
    },
    : {
IPSLA application common configurationPUTPOSTDELETEGET
      
"low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)"
      : {
Authenticaion configurationPUTPOSTDELETEGET
        
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

      }
    },
    : {
Responder configurationPUTPOSTDELETEGET
      
"enable": "null", Starts the responder process
      : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
        : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
          : {
Configure IP addressPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"local-address": "string", IP address of the Responder
                : {
Configure portPUTPOSTDELETEGET
                  : [
Port number to be enabledPUTPOSTDELETEGET
                    {
                      
"port": "string" Port number to be enabled

                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPSLA - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/

Create operation of resource: ipsla

ipsla_schema

ipslabody object

Request Content-Types: application/json
Request Example
{
  : {
IPSLA configurationPUTPOSTDELETEGET
    : {
Provider Edge(PE) discovery configurationPUTPOSTDELETEGET
      : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
        
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

      }
    },
    : {
IPSLA Operation configurationPUTPOSTDELETEGET
      : {
Reaction trigger configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Reaction condition specificationPUTPOSTDELETEGET
              : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on round trip time threshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on error verfication violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              }
            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Operation type specificationPUTPOSTDELETEGET
              : {
UDPEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"verify-data": "null", Check each IPSLA response for corruption

                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"dest-port": "string", Port number on target device

                
"control-disable": "null", Disable control packets

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"source-port": "string", Port number on source device

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                }
              },
              : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance
                : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                  
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
                : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                  
"node8": "string", IPv4 address of the intermediate node

                  
"node1": "string", IPv4 address of the intermediate node

                  
"node3": "string", IPv4 address of the intermediate node

                  
"node2": "string", IPv4 address of the intermediate node

                  
"node5": "string", IPv4 address of the intermediate node

                  
"node4": "string", IPv4 address of the intermediate node

                  
"node7": "string", IPv4 address of the intermediate node

                  
"node6": "string" IPv4 address of the intermediate node

                },
                
"dest-address": "string" Enter IPv4 address of the destination device

              },
              : {
UDPJitter Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"verify-data": "null", Check each IPSLA response for corruption

                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance
                : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                  
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"control-disable": "null", Disable control packets

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"source-port": "string", Port number on source device

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                
"dest-port": "string" Port number on target device

              },
              : {
ICMPEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"dest-address": "string", Enter IPv4 address of the destination device

                
"source-address-v6": "string", Enter IPv6 address of the source device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                }
              },
              : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                    : {
Target FEC address with maskPUTPOSTDELETEGET
                      
"mask": "string", IP netmask for target

                      
"address": "string" No description

                    }
                  },
                  : {
Traffic engineering targetPUTPOSTDELETEGET
                    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                  }
                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"create": "null", Create MPLSLM instance with specified type

                
"tag": "string", Add a tag for this MPLSLM instance

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                },
                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              },
              : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

                  
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                  
"node8": "string", IPv4 address of the intermediate node

                  
"node1": "string", IPv4 address of the intermediate node

                  
"node3": "string", IPv4 address of the intermediate node

                  
"node2": "string", IPv4 address of the intermediate node

                  
"node5": "string", IPv4 address of the intermediate node

                  
"node4": "string", IPv4 address of the intermediate node

                  
"node7": "string", IPv4 address of the intermediate node

                  
"node6": "string" IPv4 address of the intermediate node

                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string", Choose type of data to be stored in history\nbuffer

                  
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

                }
              },
              : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                  : {
Pseudowire targetPUTPOSTDELETEGET
                    : {
Target addressPUTPOSTDELETEGET
                      
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                      
"address": "string" No description

                    }
                  },
                  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                    : {
Target FEC address with maskPUTPOSTDELETEGET
                      
"mask": "string", IP netmask for target

                      
"address": "string" No description

                    }
                  },
                  : {
Traffic engineering targetPUTPOSTDELETEGET
                    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                  }
                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                },
                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              }
            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM schedule configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

            
"life": "string", Length of the time to execute (default 3600\nseconds)

            
"recurring": "null", probe to be scheduled automatically every day
            : {
Start time of MPLSLM instancePUTPOSTDELETEGET
              
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

              
"month": "string", Month of the year (optional. Default current\nmonth)

              
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

              
"schedule-type": "string", Type of schedule

              
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

              
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

              
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      }
    },
    : {
MPLS LSP Monitor(MPLSLM) configurationPUTPOSTDELETEGET
      : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Reaction condition specificationPUTPOSTDELETEGET
              : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              }
            },
            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      },
      : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Operation type specificationPUTPOSTDELETEGET
              : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                },
                : {
Scanning parameters configurationPUTPOSTDELETEGET
                  
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"create": "null", Create MPLSLM instance with specified type

                
"accesslist": "string", Apply access list to filter PE addresses

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"tag": "string", Add a tag for this MPLSLM instance

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              },
              : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                },
                : {
Path discover configurationPUTPOSTDELETEGET
                  : {
Path parameters configurationPUTPOSTDELETEGET
                    : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
                      
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                      
"type": "string" Configure IPSLA Responder port type

                    },
                    
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                  },
                  
"create": "null", Create MPLSLM instance with specified type
                  : {
Session parameters configurationPUTPOSTDELETEGET
                    
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

                    
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                  },
                  
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
                  : {
Echo parameters configurationPUTPOSTDELETEGET
                    
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
                    : {
Downstream map multipath settingsPUTPOSTDELETEGET
                      
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

                    },
                    
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                  }
                },
                : {
Scanning parameters configurationPUTPOSTDELETEGET
                  
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"accesslist": "string", Apply access list to filter PE addresses

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"tag": "string", Add a tag for this MPLSLM instance

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              }
            },
            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM schedule configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
            : {
Start time of MPLSLM instancePUTPOSTDELETEGET
              
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

              
"month": "string", Month of the year (optional. Default current\nmonth)

              
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

              
"schedule-type": "string", Type of schedule

              
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

              
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

              
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

            },
            
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"

            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      }
    },
    : {
IPSLA application common configurationPUTPOSTDELETEGET
      
"low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)"
      : {
Authenticaion configurationPUTPOSTDELETEGET
        
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

      }
    },
    : {
Responder configurationPUTPOSTDELETEGET
      
"enable": "null", Starts the responder process
      : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
        : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
          : {
Configure IP addressPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"local-address": "string", IP address of the Responder
                : {
Configure portPUTPOSTDELETEGET
                  : [
Port number to be enabledPUTPOSTDELETEGET
                    {
                      
"port": "string" Port number to be enabled

                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPSLA - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/

Delete operation of resource: ipsla

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPSLA - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/

Retrieve operation of resource: ipsla

200 OK
ipsla_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPSLA configurationPUTPOSTDELETEGET
    : {
Provider Edge(PE) discovery configurationPUTPOSTDELETEGET
      : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
        
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

      }
    },
    : {
IPSLA Operation configurationPUTPOSTDELETEGET
      : {
Reaction trigger configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Reaction condition specificationPUTPOSTDELETEGET
              : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on round trip time threshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                  
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                  
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

                },
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                },
                
"create": "null" Create MPLSLM instance with specified type

              },
              : {
React on error verfication violationPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              }
            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Operation type specificationPUTPOSTDELETEGET
              : {
UDPEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"verify-data": "null", Check each IPSLA response for corruption

                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"dest-port": "string", Port number on target device

                
"control-disable": "null", Disable control packets

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"source-port": "string", Port number on source device

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                }
              },
              : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance
                : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                  
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
                : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                  
"node8": "string", IPv4 address of the intermediate node

                  
"node1": "string", IPv4 address of the intermediate node

                  
"node3": "string", IPv4 address of the intermediate node

                  
"node2": "string", IPv4 address of the intermediate node

                  
"node5": "string", IPv4 address of the intermediate node

                  
"node4": "string", IPv4 address of the intermediate node

                  
"node7": "string", IPv4 address of the intermediate node

                  
"node6": "string" IPv4 address of the intermediate node

                },
                
"dest-address": "string" Enter IPv4 address of the destination device

              },
              : {
UDPJitter Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"verify-data": "null", Check each IPSLA response for corruption

                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance
                : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                  
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"control-disable": "null", Disable control packets

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"source-port": "string", Port number on source device

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                
"dest-port": "string" Port number on target device

              },
              : {
ICMPEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"dest-address": "string", Enter IPv4 address of the destination device

                
"source-address-v6": "string", Enter IPv6 address of the source device
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                }
              },
              : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                    : {
Target FEC address with maskPUTPOSTDELETEGET
                      
"mask": "string", IP netmask for target

                      
"address": "string" No description

                    }
                  },
                  : {
Traffic engineering targetPUTPOSTDELETEGET
                    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                  }
                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"create": "null", Create MPLSLM instance with specified type

                
"tag": "string", Add a tag for this MPLSLM instance

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                },
                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              },
              : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

                  
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"dest-address": "string", Enter IPv4 address of the destination device
                : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                  
"node8": "string", IPv4 address of the intermediate node

                  
"node1": "string", IPv4 address of the intermediate node

                  
"node3": "string", IPv4 address of the intermediate node

                  
"node2": "string", IPv4 address of the intermediate node

                  
"node5": "string", IPv4 address of the intermediate node

                  
"node4": "string", IPv4 address of the intermediate node

                  
"node7": "string", IPv4 address of the intermediate node

                  
"node6": "string" IPv4 address of the intermediate node

                },
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string", Choose type of data to be stored in history\nbuffer

                  
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

                }
              },
              : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
                : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                      
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                    }
                  ]
                },
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                  
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                  
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

                },
                : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                  : {
Pseudowire targetPUTPOSTDELETEGET
                    : {
Target addressPUTPOSTDELETEGET
                      
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                      
"address": "string" No description

                    }
                  },
                  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                    : {
Target FEC address with maskPUTPOSTDELETEGET
                      
"mask": "string", IP netmask for target

                      
"address": "string" No description

                    }
                  },
                  : {
Traffic engineering targetPUTPOSTDELETEGET
                    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                  }
                },
                
"source-address": "string", Enter IPv4 address of the source device

                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"tag": "string", Add a tag for this MPLSLM instance

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"
                : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                  
"history-filter": "string" Choose type of data to be stored in history\nbuffer

                },
                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              }
            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM schedule configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

            
"life": "string", Length of the time to execute (default 3600\nseconds)

            
"recurring": "null", probe to be scheduled automatically every day
            : {
Start time of MPLSLM instancePUTPOSTDELETEGET
              
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

              
"month": "string", Month of the year (optional. Default current\nmonth)

              
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

              
"schedule-type": "string", Type of schedule

              
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

              
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

              
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

            },
            
"operation-id": "integer" Operation number
range: "1..2048"

          }
        ]
      }
    },
    : {
MPLS LSP Monitor(MPLSLM) configurationPUTPOSTDELETEGET
      : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Reaction condition specificationPUTPOSTDELETEGET
              : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              },
              : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
                : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                  
"thresh-type": "string", Type of thresholding to perform

                  
"count1": "integer", Probe count for consecutive
range: "1..16"

                  
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                  
"logging": "null" Generate a syslog alarm on threshold violation

                }
              }
            },
            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      },
      : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Operation type specificationPUTPOSTDELETEGET
              : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                },
                : {
Scanning parameters configurationPUTPOSTDELETEGET
                  
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"create": "null", Create MPLSLM instance with specified type

                
"accesslist": "string", Apply access list to filter PE addresses

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"tag": "string", Add a tag for this MPLSLM instance

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              },
              : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
                : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                  
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                },
                : {
Path discover configurationPUTPOSTDELETEGET
                  : {
Path parameters configurationPUTPOSTDELETEGET
                    : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
                      
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                      
"type": "string" Configure IPSLA Responder port type

                    },
                    
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                  },
                  
"create": "null", Create MPLSLM instance with specified type
                  : {
Session parameters configurationPUTPOSTDELETEGET
                    
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

                    
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                  },
                  
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
                  : {
Echo parameters configurationPUTPOSTDELETEGET
                    
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
                    : {
Downstream map multipath settingsPUTPOSTDELETEGET
                      
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

                    },
                    
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                  }
                },
                : {
Scanning parameters configurationPUTPOSTDELETEGET
                  
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                  
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

                },
                
"accesslist": "string", Apply access list to filter PE addresses

                
"output-interface": "string", Echo request output interface

                
"output-nexthop": "string", Echo request output nexthop

                
"tag": "string", Add a tag for this MPLSLM instance

                
"vrf": "string", Specify a VRF instance to be monitored

                
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
                : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                  
"mode": "string", Enables use of router alert in echo reply\npackets

                  
"dscp-bits": "string" DSCP bits in the reply IP header

                },
                
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

                
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

                
"force-explicit-null": "null" Forced option for the MPLS LSP operation

              }
            },
            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      },
      : {
MPLSLM schedule configurationPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
            : {
Start time of MPLSLM instancePUTPOSTDELETEGET
              
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

              
"month": "string", Month of the year (optional. Default current\nmonth)

              
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

              
"schedule-type": "string", Type of schedule

              
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

              
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

              
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

            },
            
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"

            
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

          }
        ]
      }
    },
    : {
IPSLA application common configurationPUTPOSTDELETEGET
      
"low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)"
      : {
Authenticaion configurationPUTPOSTDELETEGET
        
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

      }
    },
    : {
Responder configurationPUTPOSTDELETEGET
      
"enable": "null", Starts the responder process
      : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
        : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
          : {
Configure IP addressPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"local-address": "string", IP address of the Responder
                : {
Configure portPUTPOSTDELETEGET
                  : [
Port number to be enabledPUTPOSTDELETEGET
                    {
                      
"port": "string" Port number to be enabled

                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

COMMON - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/

Update operation of resource: common

common_schema

commonbody object

Request Content-Types: application/json
Request Example
{
  : {
IPSLA application common configurationPUTPOSTDELETEGET
    
"low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)"
    : {
Authenticaion configurationPUTPOSTDELETEGET
      
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

COMMON - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/

Create operation of resource: common

common_schema

commonbody object

Request Content-Types: application/json
Request Example
{
  : {
IPSLA application common configurationPUTPOSTDELETEGET
    
"low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)"
    : {
Authenticaion configurationPUTPOSTDELETEGET
      
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

COMMON - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/

Delete operation of resource: common

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

COMMON - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/

Retrieve operation of resource: common

200 OK
common_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPSLA application common configurationPUTPOSTDELETEGET
    
"low-memory": "integer", Configure low memory water mark (default 20M)
range: "0..4294967295"
default: 20M)"
    : {
Authenticaion configurationPUTPOSTDELETEGET
      
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

    }
  }
}

AUTHENTICATION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/authentication/

Update operation of resource: authentication

authentication_schema

authenticationbody object

Request Content-Types: application/json
Request Example
{
  : {
Authenticaion configurationPUTPOSTDELETEGET
    
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTHENTICATION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/authentication/

Create operation of resource: authentication

authentication_schema

authenticationbody object

Request Content-Types: application/json
Request Example
{
  : {
Authenticaion configurationPUTPOSTDELETEGET
    
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTHENTICATION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/authentication/

Delete operation of resource: authentication

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTHENTICATION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/common/authentication/

Retrieve operation of resource: authentication

200 OK
authentication_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Authenticaion configurationPUTPOSTDELETEGET
    
"key-chain": "string" Use MD5 authentication for IPSLA control\nmessage

  }
}

MPLS-LSP-MONITOR - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/

Update operation of resource: mpls-lsp-monitor

mpls-lsp-monitor_schema

mpls-lsp-monitorbody object

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Monitor(MPLSLM) configurationPUTPOSTDELETEGET
    : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Reaction condition specificationPUTPOSTDELETEGET
            : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for consecutive
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for consecutive
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            }
          },
          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    },
    : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Operation type specificationPUTPOSTDELETEGET
            : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              },
              : {
Scanning parameters configurationPUTPOSTDELETEGET
                
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

              },
              
"create": "null", Create MPLSLM instance with specified type

              
"accesslist": "string", Apply access list to filter PE addresses

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"tag": "string", Add a tag for this MPLSLM instance

              
"vrf": "string", Specify a VRF instance to be monitored

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            },
            : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              },
              : {
Path discover configurationPUTPOSTDELETEGET
                : {
Path parameters configurationPUTPOSTDELETEGET
                  : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
                    
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                    
"type": "string" Condition type of path failure

                  },
                  
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Session parameters configurationPUTPOSTDELETEGET
                  
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

                  
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                },
                
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
                : {
Echo parameters configurationPUTPOSTDELETEGET
                  
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
                  : {
Downstream map multipath settingsPUTPOSTDELETEGET
                    
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

                  },
                  
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                  
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                }
              },
              : {
Scanning parameters configurationPUTPOSTDELETEGET
                
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"accesslist": "string", Apply access list to filter PE addresses

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"tag": "string", Add a tag for this MPLSLM instance

              
"vrf": "string", Specify a VRF instance to be monitored

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            }
          },
          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    },
    : {
MPLSLM schedule configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
          : {
Start time of MPLSLM instancePUTPOSTDELETEGET
            
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

            
"month": "string", Month of the year (optional. Default current\nmonth)

            
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

            
"schedule-type": "string", Type of schedule

            
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

            
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

            
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

          },
          
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"

          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-MONITOR - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/

Create operation of resource: mpls-lsp-monitor

mpls-lsp-monitor_schema

mpls-lsp-monitorbody object

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Monitor(MPLSLM) configurationPUTPOSTDELETEGET
    : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Reaction condition specificationPUTPOSTDELETEGET
            : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for consecutive
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for consecutive
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            }
          },
          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    },
    : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Operation type specificationPUTPOSTDELETEGET
            : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              },
              : {
Scanning parameters configurationPUTPOSTDELETEGET
                
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

              },
              
"create": "null", Create MPLSLM instance with specified type

              
"accesslist": "string", Apply access list to filter PE addresses

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"tag": "string", Add a tag for this MPLSLM instance

              
"vrf": "string", Specify a VRF instance to be monitored

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            },
            : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              },
              : {
Path discover configurationPUTPOSTDELETEGET
                : {
Path parameters configurationPUTPOSTDELETEGET
                  : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
                    
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                    
"type": "string" Condition type of path failure

                  },
                  
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Session parameters configurationPUTPOSTDELETEGET
                  
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

                  
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                },
                
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
                : {
Echo parameters configurationPUTPOSTDELETEGET
                  
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
                  : {
Downstream map multipath settingsPUTPOSTDELETEGET
                    
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

                  },
                  
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                  
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                }
              },
              : {
Scanning parameters configurationPUTPOSTDELETEGET
                
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"accesslist": "string", Apply access list to filter PE addresses

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"tag": "string", Add a tag for this MPLSLM instance

              
"vrf": "string", Specify a VRF instance to be monitored

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            }
          },
          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    },
    : {
MPLSLM schedule configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
          : {
Start time of MPLSLM instancePUTPOSTDELETEGET
            
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

            
"month": "string", Month of the year (optional. Default current\nmonth)

            
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

            
"schedule-type": "string", Type of schedule

            
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

            
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

            
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

          },
          
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"

          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-MONITOR - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/

Delete operation of resource: mpls-lsp-monitor

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-MONITOR - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/

Retrieve operation of resource: mpls-lsp-monitor

200 OK
mpls-lsp-monitor_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
MPLS LSP Monitor(MPLSLM) configurationPUTPOSTDELETEGET
    : {
MPLSLM Reaction configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Reaction condition specificationPUTPOSTDELETEGET
            : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for consecutive
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on connection loss for a monitored\nMPLSLMPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for consecutive
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            }
          },
          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    },
    : {
MPLS LSP Monitor definition tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Operation type specificationPUTPOSTDELETEGET
            : {
Perform MPLS LSP Trace operationPUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              },
              : {
Scanning parameters configurationPUTPOSTDELETEGET
                
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

              },
              
"create": "null", Create MPLSLM instance with specified type

              
"accesslist": "string", Apply access list to filter PE addresses

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"tag": "string", Add a tag for this MPLSLM instance

              
"vrf": "string", Specify a VRF instance to be monitored

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            },
            : {
Perform MPLS LSP Ping operationPUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer" Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              },
              : {
Path discover configurationPUTPOSTDELETEGET
                : {
Path parameters configurationPUTPOSTDELETEGET
                  : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
                    
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"

                    
"type": "string" Condition type of path failure

                  },
                  
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                },
                
"create": "null", Create MPLSLM instance with specified type
                : {
Session parameters configurationPUTPOSTDELETEGET
                  
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

                  
"timeout": "integer" Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                },
                
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
                : {
Echo parameters configurationPUTPOSTDELETEGET
                  
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
                  : {
Downstream map multipath settingsPUTPOSTDELETEGET
                    
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

                  },
                  
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

                  
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

                  
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

                }
              },
              : {
Scanning parameters configurationPUTPOSTDELETEGET
                
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

                
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

              },
              
"create": "null", Create MPLSLM instance with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"accesslist": "string", Apply access list to filter PE addresses

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"tag": "string", Add a tag for this MPLSLM instance

              
"vrf": "string", Specify a VRF instance to be monitored

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP operationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo request header
range: "0..7"
default: "0"

              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            }
          },
          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    },
    : {
MPLSLM schedule configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"frequency": "integer", Group schedule frequency of the probing
range: "1..604800"
units: "second"
default: "60"
          : {
Start time of MPLSLM instancePUTPOSTDELETEGET
            
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

            
"month": "string", Month of the year (optional. Default current\nmonth)

            
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

            
"schedule-type": "string", Type of schedule

            
"year": "integer", Year (optional. Default current year)
range: "1993..2035"

            
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

            
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

          },
          
"period": "integer", Group schedule period range
range: "1..604800"
units: "second"

          
"monitor-id": "integer" Monitor indentifier
range: "1..2048"

        }
      ]
    }
  }
}

REACTIONS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/

Update operation of resource: reactions

reactions_schema

reactionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Reaction configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Reaction condition specificationPUTPOSTDELETEGET
          : {
React on probe timeoutPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on destination to source jitter\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on round trip time threshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on source to destination packet loss\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average source to destination\njitter threshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on destination to source packet loss\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average round trip jitter threshold\nviolation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on error verfication violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTIONS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/

Create operation of resource: reactions

reactions_schema

reactionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Reaction configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Reaction condition specificationPUTPOSTDELETEGET
          : {
React on probe timeoutPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on destination to source jitter\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on round trip time threshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on source to destination packet loss\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average source to destination\njitter threshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on destination to source packet loss\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average round trip jitter threshold\nviolation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on error verfication violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTIONS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/

Delete operation of resource: reactions

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTIONS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/

Retrieve operation of resource: reactions

200 OK
reactions_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Reaction configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Reaction condition specificationPUTPOSTDELETEGET
          : {
React on probe timeoutPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on destination to source jitter\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on round trip time threshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on source to destination packet loss\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average source to destination\njitter threshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on destination to source packet loss\nthreshold violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average round trip jitter threshold\nviolation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelement
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on error verfication violation
            : {
Type of thresholding to perform on the monitored\nelement
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}

REACTION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/

Update operation of resource: reaction

reaction_schema

reactionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Reaction condition specificationPUTPOSTDELETEGET
        : {
React on probe timeoutPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on destination to source jitter\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on round trip time threshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on source to destination packet loss\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average source to destination\njitter threshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on destination to source packet loss\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average round trip jitter threshold\nviolation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on error verfication violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/

Create operation of resource: reaction

reaction_schema

reactionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Reaction condition specificationPUTPOSTDELETEGET
        : {
React on probe timeoutPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on destination to source jitter\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on round trip time threshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on source to destination packet loss\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average source to destination\njitter threshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on destination to source packet loss\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average round trip jitter threshold\nviolation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on error verfication violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/

Delete operation of resource: reaction

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/

Retrieve operation of resource: reaction

monitor-id: string
in path

ID of monitor-id

200 OK
reaction_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Reaction condition specificationPUTPOSTDELETEGET
        : {
React on probe timeoutPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on destination to source jitter\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on round trip time threshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on source to destination packet loss\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average source to destination\njitter threshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on destination to source packet loss\nthreshold violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average round trip jitter threshold\nviolation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelement
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on error verfication violation
          : {
Type of thresholding to perform on the monitored\nelement
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}

CONDITION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/

Update operation of resource: condition

condition_schema

conditionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Reaction condition specificationPUTPOSTDELETEGET
    : {
React on probe timeoutPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on destination to source jitter\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on round trip time threshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on source to destination packet loss\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average source to destination\njitter threshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on destination to source packet loss\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average round trip jitter threshold\nviolation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on error verfication violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONDITION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/

Create operation of resource: condition

condition_schema

conditionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Reaction condition specificationPUTPOSTDELETEGET
    : {
React on probe timeoutPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on destination to source jitter\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on round trip time threshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on source to destination packet loss\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average source to destination\njitter threshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on destination to source packet loss\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average round trip jitter threshold\nviolation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on error verfication violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONDITION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/

Delete operation of resource: condition

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONDITION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/

Retrieve operation of resource: condition

monitor-id: string
in path

ID of monitor-id

200 OK
condition_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Reaction condition specificationPUTPOSTDELETEGET
    : {
React on probe timeoutPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on destination to source jitter\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on round trip time threshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on source to destination packet loss\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average source to destination\njitter threshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on destination to source packet loss\nthreshold violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average round trip jitter threshold\nviolation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelement
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on error verfication violation
      : {
Type of thresholding to perform on the monitored\nelement
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    }
  }
}

LPD-TREE-TRACE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/

Update operation of resource: lpd-tree-trace

lpd-tree-trace_schema

lpd-tree-tracebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
    
"create": "null", Create reaction condition for a particular\nMPLSLM
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LPD-TREE-TRACE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/

Create operation of resource: lpd-tree-trace

lpd-tree-trace_schema

lpd-tree-tracebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
    
"create": "null", Create reaction condition for a particular\nMPLSLM
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LPD-TREE-TRACE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/

Delete operation of resource: lpd-tree-trace

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LPD-TREE-TRACE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/

Retrieve operation of resource: lpd-tree-trace

monitor-id: string
in path

ID of monitor-id

200 OK
lpd-tree-trace_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on LPD Tree Trace violation for a\nmonitored MPLSLMPUTPOSTDELETEGET
    
"create": "null", Create reaction condition for a particular\nMPLSLM
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/action-type/

Delete operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-tree-trace/action-type/

Retrieve operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

TIMEOUT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/

Update operation of resource: timeout

timeout_schema

timeoutbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on probe timeoutPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/

Create operation of resource: timeout

timeout_schema

timeoutbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on probe timeoutPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/

Delete operation of resource: timeout

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/

Retrieve operation of resource: timeout

monitor-id: string
in path

ID of monitor-id

200 OK
timeout_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on probe timeoutPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/action-type/

Delete operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/action-type/

Retrieve operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/threshold-type/

Delete operation of resource: threshold-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/timeout/threshold-type/

Retrieve operation of resource: threshold-type

monitor-id: string
in path

ID of monitor-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

LPD-GROUP - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/

Update operation of resource: lpd-group

lpd-group_schema

lpd-groupbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
    
"create": "null", Create reaction condition for a particular\nMPLSLM
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LPD-GROUP - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/

Create operation of resource: lpd-group

lpd-group_schema

lpd-groupbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
    
"create": "null", Create reaction condition for a particular\nMPLSLM
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LPD-GROUP - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/

Delete operation of resource: lpd-group

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LPD-GROUP - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/

Retrieve operation of resource: lpd-group

monitor-id: string
in path

ID of monitor-id

200 OK
lpd-group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on LPD Group violation for a monitored\nMPLSLMPUTPOSTDELETEGET
    
"create": "null", Create reaction condition for a particular\nMPLSLM
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/action-type/

Delete operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/lpd-group/action-type/

Retrieve operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

CONNECTION-LOSS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/

Update operation of resource: connection-loss

connection-loss_schema

connection-lossbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTION-LOSS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/

Create operation of resource: connection-loss

connection-loss_schema

connection-lossbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTION-LOSS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/

Delete operation of resource: connection-loss

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTION-LOSS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/

Retrieve operation of resource: connection-loss

monitor-id: string
in path

ID of monitor-id

200 OK
connection-loss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/action-type/

Delete operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/action-type/

Retrieve operation of resource: action-type

monitor-id: string
in path

ID of monitor-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/threshold-type/

Delete operation of resource: threshold-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/reactions/reaction/{monitor-id}/condition/connection-loss/threshold-type/

Retrieve operation of resource: threshold-type

monitor-id: string
in path

ID of monitor-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

SCHEDULES - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/

Update operation of resource: schedules

schedules_schema

schedulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Schedule an operationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

        
"life": "string", Length of the time to execute (default 3600\nseconds)

        
"recurring": "null", probe to be scheduled automatically every day
        : {
Start time of the operationPUTPOSTDELETEGET
          
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

          
"month": "string", Month of the year (optional. Default current\nmonth)

          
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

          
"schedule-type": "string", Type of schedule

          
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

          
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

          
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULES - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/

Create operation of resource: schedules

schedules_schema

schedulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Schedule an operationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

        
"life": "string", Length of the time to execute (default 3600\nseconds)

        
"recurring": "null", probe to be scheduled automatically every day
        : {
Start time of the operationPUTPOSTDELETEGET
          
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

          
"month": "string", Month of the year (optional. Default current\nmonth)

          
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

          
"schedule-type": "string", Type of schedule

          
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

          
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

          
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULES - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/

Delete operation of resource: schedules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULES - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/

Retrieve operation of resource: schedules

200 OK
schedules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Schedule an operationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

        
"life": "string", Length of the time to execute (default 3600\nseconds)

        
"recurring": "null", probe to be scheduled automatically every day
        : {
Start time of the operationPUTPOSTDELETEGET
          
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

          
"month": "string", Month of the year (optional. Default current\nmonth)

          
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

          
"schedule-type": "string", Type of schedule

          
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

          
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

          
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}

SCHEDULE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/

Update operation of resource: schedule

schedule_schema

schedulebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

      
"life": "string", Length of the time to execute (default 3600\nseconds)

      
"recurring": "null", probe to be scheduled automatically every day
      : {
Start time of the operationPUTPOSTDELETEGET
        
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

        
"month": "string", Month of the year (optional. Default current\nmonth)

        
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

        
"schedule-type": "string", Type of schedule

        
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

        
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

        
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/

Create operation of resource: schedule

schedule_schema

schedulebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

      
"life": "string", Length of the time to execute (default 3600\nseconds)

      
"recurring": "null", probe to be scheduled automatically every day
      : {
Start time of the operationPUTPOSTDELETEGET
        
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

        
"month": "string", Month of the year (optional. Default current\nmonth)

        
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

        
"schedule-type": "string", Type of schedule

        
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

        
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

        
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/

Delete operation of resource: schedule

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/

Retrieve operation of resource: schedule

monitor-id: string
in path

ID of monitor-id

200 OK
schedule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

      
"life": "string", Length of the time to execute (default 3600\nseconds)

      
"recurring": "null", probe to be scheduled automatically every day
      : {
Start time of the operationPUTPOSTDELETEGET
        
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

        
"month": "string", Month of the year (optional. Default current\nmonth)

        
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

        
"schedule-type": "string", Type of schedule

        
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

        
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

        
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}

START-TIME - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/start-time/

Update operation of resource: start-time

start-time_schema

start-timebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Start time of the operationPUTPOSTDELETEGET
    
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

    
"month": "string", Month of the year (optional. Default current\nmonth)

    
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

    
"schedule-type": "string", Type of schedule

    
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

    
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

    
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

START-TIME - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/start-time/

Create operation of resource: start-time

start-time_schema

start-timebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Start time of the operationPUTPOSTDELETEGET
    
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

    
"month": "string", Month of the year (optional. Default current\nmonth)

    
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

    
"schedule-type": "string", Type of schedule

    
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

    
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

    
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

START-TIME - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/start-time/

Delete operation of resource: start-time

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

START-TIME - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/schedules/schedule/{monitor-id}/start-time/

Retrieve operation of resource: start-time

monitor-id: string
in path

ID of monitor-id

200 OK
start-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Start time of the operationPUTPOSTDELETEGET
    
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

    
"month": "string", Month of the year (optional. Default current\nmonth)

    
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

    
"schedule-type": "string", Type of schedule

    
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

    
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

    
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

  }
}

DEFINITIONS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/

Update operation of resource: definitions

definitions_schema

definitionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Operation definition tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Operation type specificationPUTPOSTDELETEGET
          : {
UDPEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"dest-port": "string", Port number on target device

            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
ICMPPathJitter Operation type
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparameters
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
            : {
Loose source routing path (up to 8 intermediate\nnodes)
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            
"dest-address": "string" Enter IPv4 address of the destination device

          },
          : {
UDPJitter Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparameters
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            
"dest-port": "string" Port number on target device

          },
          : {
ICMPEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device

            
"source-address-v6": "string", Enter IPv6 address of the source device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operation
              : {
Target specified as an IPv4 address
                : {
Target FEC address with mask
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering target
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type

            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          },
          : {
ICMPPathEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

              
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Loose source routing path (up to 8 intermediate\nnodes)
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string", Choose type of data to be stored in history\nbuffer

              
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

            }
          },
          : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operation
              : {
Pseudowire target
                : {
Target address
                  
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                  
"address": "string" IP address for target

                }
              },
              : {
Target specified as an IPv4 address
                : {
Target FEC address with mask
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering target
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITIONS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/

Create operation of resource: definitions

definitions_schema

definitionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Operation definition tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Operation type specificationPUTPOSTDELETEGET
          : {
UDPEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"dest-port": "string", Port number on target device

            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
ICMPPathJitter Operation type
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparameters
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
            : {
Loose source routing path (up to 8 intermediate\nnodes)
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            
"dest-address": "string" Enter IPv4 address of the destination device

          },
          : {
UDPJitter Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparameters
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            
"dest-port": "string" Port number on target device

          },
          : {
ICMPEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device

            
"source-address-v6": "string", Enter IPv6 address of the source device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operation
              : {
Target specified as an IPv4 address
                : {
Target FEC address with mask
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering target
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type

            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          },
          : {
ICMPPathEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

              
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Loose source routing path (up to 8 intermediate\nnodes)
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string", Choose type of data to be stored in history\nbuffer

              
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

            }
          },
          : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operation
              : {
Pseudowire target
                : {
Target address
                  
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                  
"address": "string" IP address for target

                }
              },
              : {
Target specified as an IPv4 address
                : {
Target FEC address with mask
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering target
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITIONS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/

Delete operation of resource: definitions

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITIONS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/

Retrieve operation of resource: definitions

200 OK
definitions_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Operation definition tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Operation type specificationPUTPOSTDELETEGET
          : {
UDPEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"dest-port": "string", Port number on target device

            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
ICMPPathJitter Operation type
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparameters
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
            : {
Loose source routing path (up to 8 intermediate\nnodes)
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            
"dest-address": "string" Enter IPv4 address of the destination device

          },
          : {
UDPJitter Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparameters
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            
"dest-port": "string" Port number on target device

          },
          : {
ICMPEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device

            
"source-address-v6": "string", Enter IPv6 address of the source device
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operation
              : {
Target specified as an IPv4 address
                : {
Target FEC address with mask
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering target
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type

            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          },
          : {
ICMPPathEcho Operation type
            : {
Statistics collection aggregated over an hour
              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

              
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npackets
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Loose source routing path (up to 8 intermediate\nnodes)
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string", Choose type of data to be stored in history\nbuffer

              
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

            }
          },
          : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
            : {
Table of statistics collection intervals
              : [
No description
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operation
              : {
Pseudowire target
                : {
Target address
                  
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                  
"address": "string" IP address for target

                }
              },
              : {
Target specified as an IPv4 address
                : {
Target FEC address with mask
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering target
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperation
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}

DEFINITION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/

Update operation of resource: definition

definition_schema

definitionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Operation type specificationPUTPOSTDELETEGET
        : {
UDPEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"dest-port": "string", Port number on target device

          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
ICMPPathJitter Operation type
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparameters
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
          : {
Loose source routing path (up to 8 intermediate\nnodes)
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          
"dest-address": "string" Enter IPv4 address of the destination device

        },
        : {
UDPJitter Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparameters
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          
"dest-port": "string" Port number on target device

        },
        : {
ICMPEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device

          
"source-address-v6": "string", Enter IPv6 address of the source device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operation
            : {
Target specified as an IPv4 address
              : {
Target FEC address with mask
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering target
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type

          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        },
        : {
ICMPPathEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

            
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Loose source routing path (up to 8 intermediate\nnodes)
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string", Choose type of data to be stored in history\nbuffer

            
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

          }
        },
        : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operation
            : {
Pseudowire target
              : {
Target address
                
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                
"address": "string" IP address for target

              }
            },
            : {
Target specified as an IPv4 address
              : {
Target FEC address with mask
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering target
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/

Create operation of resource: definition

definition_schema

definitionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Operation type specificationPUTPOSTDELETEGET
        : {
UDPEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"dest-port": "string", Port number on target device

          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
ICMPPathJitter Operation type
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparameters
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
          : {
Loose source routing path (up to 8 intermediate\nnodes)
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          
"dest-address": "string" Enter IPv4 address of the destination device

        },
        : {
UDPJitter Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparameters
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          
"dest-port": "string" Port number on target device

        },
        : {
ICMPEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device

          
"source-address-v6": "string", Enter IPv6 address of the source device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operation
            : {
Target specified as an IPv4 address
              : {
Target FEC address with mask
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering target
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type

          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        },
        : {
ICMPPathEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

            
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Loose source routing path (up to 8 intermediate\nnodes)
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string", Choose type of data to be stored in history\nbuffer

            
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

          }
        },
        : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operation
            : {
Pseudowire target
              : {
Target address
                
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                
"address": "string" IP address for target

              }
            },
            : {
Target specified as an IPv4 address
              : {
Target FEC address with mask
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering target
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/

Delete operation of resource: definition

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/

Retrieve operation of resource: definition

monitor-id: string
in path

ID of monitor-id

200 OK
definition_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Operation type specificationPUTPOSTDELETEGET
        : {
UDPEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"dest-port": "string", Port number on target device

          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
ICMPPathJitter Operation type
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparameters
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
          : {
Loose source routing path (up to 8 intermediate\nnodes)
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          
"dest-address": "string" Enter IPv4 address of the destination device

        },
        : {
UDPJitter Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparameters
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          
"dest-port": "string" Port number on target device

        },
        : {
ICMPEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device

          
"source-address-v6": "string", Enter IPv6 address of the source device
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operation
            : {
Target specified as an IPv4 address
              : {
Target FEC address with mask
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering target
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type

          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        },
        : {
ICMPPathEcho Operation type
          : {
Statistics collection aggregated over an hour
            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

            
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npackets
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Loose source routing path (up to 8 intermediate\nnodes)
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string", Choose type of data to be stored in history\nbuffer

            
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

          }
        },
        : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
          : {
Table of statistics collection intervals
            : [
No description
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operation
            : {
Pseudowire target
              : {
Target address
                
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                
"address": "string" IP address for target

              }
            },
            : {
Target specified as an IPv4 address
              : {
Target FEC address with mask
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering target
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperation
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}

OPERATION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/

Update operation of resource: operation-type

operation-type_schema

operation-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Operation type specificationPUTPOSTDELETEGET
    : {
UDPEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"dest-port": "string", Port number on target device

      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
ICMPPathJitter Operation type
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparameters
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
      : {
Loose source routing path (up to 8 intermediate\nnodes)
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      
"dest-address": "string" Enter IPv4 address of the destination device

    },
    : {
UDPJitter Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparameters
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      
"dest-port": "string" Port number on target device

    },
    : {
ICMPEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device

      
"source-address-v6": "string", Enter IPv6 address of the source device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operation
        : {
Target specified as an IPv4 address
          : {
Target FEC address with mask
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering target
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type

      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    },
    : {
ICMPPathEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

        
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Loose source routing path (up to 8 intermediate\nnodes)
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string", Choose type of data to be stored in history\nbuffer

        
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

      }
    },
    : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operation
        : {
Pseudowire target
          : {
Target address
            
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

            
"address": "string" IP address for target

          }
        },
        : {
Target specified as an IPv4 address
          : {
Target FEC address with mask
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering target
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/

Create operation of resource: operation-type

operation-type_schema

operation-typebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Operation type specificationPUTPOSTDELETEGET
    : {
UDPEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"dest-port": "string", Port number on target device

      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
ICMPPathJitter Operation type
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparameters
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
      : {
Loose source routing path (up to 8 intermediate\nnodes)
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      
"dest-address": "string" Enter IPv4 address of the destination device

    },
    : {
UDPJitter Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparameters
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      
"dest-port": "string" Port number on target device

    },
    : {
ICMPEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device

      
"source-address-v6": "string", Enter IPv6 address of the source device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operation
        : {
Target specified as an IPv4 address
          : {
Target FEC address with mask
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering target
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type

      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    },
    : {
ICMPPathEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

        
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Loose source routing path (up to 8 intermediate\nnodes)
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string", Choose type of data to be stored in history\nbuffer

        
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

      }
    },
    : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operation
        : {
Pseudowire target
          : {
Target address
            
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

            
"address": "string" IP address for target

          }
        },
        : {
Target specified as an IPv4 address
          : {
Target FEC address with mask
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering target
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/

Delete operation of resource: operation-type

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/

Retrieve operation of resource: operation-type

monitor-id: string
in path

ID of monitor-id

200 OK
operation-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Operation type specificationPUTPOSTDELETEGET
    : {
UDPEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"dest-port": "string", Port number on target device

      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
ICMPPathJitter Operation type
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparameters
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
      : {
Loose source routing path (up to 8 intermediate\nnodes)
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      
"dest-address": "string" Enter IPv4 address of the destination device

    },
    : {
UDPJitter Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparameters
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      
"dest-port": "string" Port number on target device

    },
    : {
ICMPEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device

      
"source-address-v6": "string", Enter IPv6 address of the source device
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operation
        : {
Target specified as an IPv4 address
          : {
Target FEC address with mask
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering target
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type

      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    },
    : {
ICMPPathEcho Operation type
      : {
Statistics collection aggregated over an hour
        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

        
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npackets
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Loose source routing path (up to 8 intermediate\nnodes)
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string", Choose type of data to be stored in history\nbuffer

        
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

      }
    },
    : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
      : {
Table of statistics collection intervals
        : [
No description
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operation
        : {
Pseudowire target
          : {
Target address
            
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

            
"address": "string" IP address for target

          }
        },
        : {
Target specified as an IPv4 address
          : {
Target FEC address with mask
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering target
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperation
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    }
  }
}

MPLS-LSP-TRACE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/

Update operation of resource: mpls-lsp-trace

mpls-lsp-trace_schema

mpls-lsp-tracebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operation
      : {
Target specified as an IPv4 address
        : {
Target FEC address with mask
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering target
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type

    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperation
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-TRACE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/

Create operation of resource: mpls-lsp-trace

mpls-lsp-trace_schema

mpls-lsp-tracebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operation
      : {
Target specified as an IPv4 address
        : {
Target FEC address with mask
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering target
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type

    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperation
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-TRACE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/

Delete operation of resource: mpls-lsp-trace

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-TRACE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/

Retrieve operation of resource: mpls-lsp-trace

monitor-id: string
in path

ID of monitor-id

200 OK
mpls-lsp-trace_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operation
      : {
Target specified as an IPv4 address
        : {
Target FEC address with mask
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering target
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type

    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperation
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}

REPLY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/reply/

Update operation of resource: reply

reply_schema

replybody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/reply/

Create operation of resource: reply

reply_schema

replybody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/reply/

Delete operation of resource: reply

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/reply/

Retrieve operation of resource: reply

monitor-id: string
in path

ID of monitor-id

200 OK
reply_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/statistics/

Delete operation of resource: statistics

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/statistics/

Retrieve operation of resource: statistics

monitor-id: string
in path

ID of monitor-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

SCAN - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/scan/

Update operation of resource: scan

scan_schema

scanbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Scanning parameters configurationPUTPOSTDELETEGET
    
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCAN - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/scan/

Create operation of resource: scan

scan_schema

scanbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Scanning parameters configurationPUTPOSTDELETEGET
    
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCAN - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/scan/

Delete operation of resource: scan

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCAN - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-trace/scan/

Retrieve operation of resource: scan

monitor-id: string
in path

ID of monitor-id

200 OK
scan_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Scanning parameters configurationPUTPOSTDELETEGET
    
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

  }
}

MPLS-LSP-PING - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/

Update operation of resource: mpls-lsp-ping

mpls-lsp-ping_schema

mpls-lsp-pingbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
    : {
Table of statistics collection intervals
      : [
No description
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operation
      : {
Pseudowire target
        : {
Target address
          
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

          
"address": "string" IP address for target

        }
      },
      : {
Target specified as an IPv4 address
        : {
Target FEC address with mask
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering target
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperation
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-PING - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/

Create operation of resource: mpls-lsp-ping

mpls-lsp-ping_schema

mpls-lsp-pingbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
    : {
Table of statistics collection intervals
      : [
No description
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operation
      : {
Pseudowire target
        : {
Target address
          
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

          
"address": "string" IP address for target

        }
      },
      : {
Target specified as an IPv4 address
        : {
Target FEC address with mask
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering target
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperation
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-PING - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/

Delete operation of resource: mpls-lsp-ping

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-PING - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/

Retrieve operation of resource: mpls-lsp-ping

monitor-id: string
in path

ID of monitor-id

200 OK
mpls-lsp-ping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
    : {
Table of statistics collection intervals
      : [
No description
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operation
      : {
Pseudowire target
        : {
Target address
          
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

          
"address": "string" IP address for target

        }
      },
      : {
Target specified as an IPv4 address
        : {
Target FEC address with mask
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering target
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperation
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/data-size/

Delete operation of resource: data-size

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/data-size/

Retrieve operation of resource: data-size

monitor-id: string
in path

ID of monitor-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

PATH-DISCOVER - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/

Update operation of resource: path-discover

path-discover_schema

path-discoverbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Path discover configurationPUTPOSTDELETEGET
    : {
Path parameters configurationPUTPOSTDELETEGET
      : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
        
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

        
"type": "string" Condition type of path failure

      },
      
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

    },
    
"create": "null", Create LPD instance
    : {
Session parameters configurationPUTPOSTDELETEGET
      
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

      
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

    },
    
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
    : {
Echo parameters configurationPUTPOSTDELETEGET
      
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
      : {
Downstream map multipath settingsPUTPOSTDELETEGET
        
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

      },
      
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

      
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

      
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH-DISCOVER - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/

Create operation of resource: path-discover

path-discover_schema

path-discoverbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Path discover configurationPUTPOSTDELETEGET
    : {
Path parameters configurationPUTPOSTDELETEGET
      : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
        
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

        
"type": "string" Condition type of path failure

      },
      
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

    },
    
"create": "null", Create LPD instance
    : {
Session parameters configurationPUTPOSTDELETEGET
      
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

      
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

    },
    
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
    : {
Echo parameters configurationPUTPOSTDELETEGET
      
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
      : {
Downstream map multipath settingsPUTPOSTDELETEGET
        
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

      },
      
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

      
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

      
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH-DISCOVER - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/

Delete operation of resource: path-discover

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH-DISCOVER - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/

Retrieve operation of resource: path-discover

monitor-id: string
in path

ID of monitor-id

200 OK
path-discover_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Path discover configurationPUTPOSTDELETEGET
    : {
Path parameters configurationPUTPOSTDELETEGET
      : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
        
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

        
"type": "string" Condition type of path failure

      },
      
"retry": "integer" Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

    },
    
"create": "null", Create LPD instance
    : {
Session parameters configurationPUTPOSTDELETEGET
      
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

      
"timeout": "integer" Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

    },
    
"scan-period": "integer", Time period for finishing path discovery
range: "0..7200"
units: "minute"
default: "0"
    : {
Echo parameters configurationPUTPOSTDELETEGET
      
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
      : {
Downstream map multipath settingsPUTPOSTDELETEGET
        
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

      },
      
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

      
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

      
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"

    }
  }
}

SESSION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/session/

Update operation of resource: session

session_schema

sessionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Session parameters configurationPUTPOSTDELETEGET
    
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

    
"timeout": "integer" Timeout value for path discovery request
range: "1..600000"
units: "millisecond"
default: "5000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/session/

Create operation of resource: session

session_schema

sessionbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Session parameters configurationPUTPOSTDELETEGET
    
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

    
"timeout": "integer" Timeout value for path discovery request
range: "1..600000"
units: "millisecond"
default: "5000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/session/

Delete operation of resource: session

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/session/

Retrieve operation of resource: session

monitor-id: string
in path

ID of monitor-id

200 OK
session_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Session parameters configurationPUTPOSTDELETEGET
    
"limit": "integer", Number of concurrent active path\ndiscovery requests at one time
range: "1..15"
default: "1"

    
"timeout": "integer" Timeout value for path discovery request
range: "1..600000"
units: "millisecond"
default: "5000"

  }
}

PATH - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/

Update operation of resource: path

path_schema

pathbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Path parameters configurationPUTPOSTDELETEGET
    : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
      
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

      
"type": "string" Condition type of path failure

    },
    
"retry": "integer" Number of attempts before declaring the\npath as down
range: "0..100"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/

Create operation of resource: path

path_schema

pathbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Path parameters configurationPUTPOSTDELETEGET
    : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
      
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

      
"type": "string" Condition type of path failure

    },
    
"retry": "integer" Number of attempts before declaring the\npath as down
range: "0..100"
default: "1"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/

Delete operation of resource: path

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PATH - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/

Retrieve operation of resource: path

monitor-id: string
in path

ID of monitor-id

200 OK
path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Path parameters configurationPUTPOSTDELETEGET
    : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
      
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

      
"type": "string" Condition type of path failure

    },
    
"retry": "integer" Number of attempts before declaring the\npath as down
range: "0..100"
default: "1"

  }
}

SECONDARY-FREQUENCY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/secondary-frequency/

Update operation of resource: secondary-frequency

secondary-frequency_schema

secondary-frequencybody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
    
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

    
"type": "string" Condition type of path failure

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-FREQUENCY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/secondary-frequency/

Create operation of resource: secondary-frequency

secondary-frequency_schema

secondary-frequencybody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
    
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

    
"type": "string" Condition type of path failure

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-FREQUENCY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/secondary-frequency/

Delete operation of resource: secondary-frequency

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-FREQUENCY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/path/secondary-frequency/

Retrieve operation of resource: secondary-frequency

monitor-id: string
in path

ID of monitor-id

200 OK
secondary-frequency_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Frequency to be used if path failure\ncondition is detectedPUTPOSTDELETEGET
    
"frequency": "integer", Frequency value in seconds
range: "1..604800"
units: "second"
default: "60"

    
"type": "string" Condition type of path failure

  }
}

ECHO - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/

Update operation of resource: echo

echo_schema

echobody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Echo parameters configurationPUTPOSTDELETEGET
    
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
    : {
Downstream map multipath settingsPUTPOSTDELETEGET
      
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

    },
    
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

    
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

    
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ECHO - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/

Create operation of resource: echo

echo_schema

echobody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Echo parameters configurationPUTPOSTDELETEGET
    
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
    : {
Downstream map multipath settingsPUTPOSTDELETEGET
      
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

    },
    
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

    
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

    
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ECHO - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/

Delete operation of resource: echo

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ECHO - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/

Retrieve operation of resource: echo

monitor-id: string
in path

ID of monitor-id

200 OK
echo_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Echo parameters configurationPUTPOSTDELETEGET
    
"maximum-lsp-selector": "string", Maximum IPv4 address used as destination\nin echo request
    : {
Downstream map multipath settingsPUTPOSTDELETEGET
      
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

    },
    
"retry": "integer", Number of timeout retry attempts during\npath discovery
range: "0..100"
default: "1"

    
"timeout": "integer", Timeout value for echo requests during\npath discovery
range: "1..600000"
units: "millisecond"
default: "5000"

    
"interval": "integer" Send interval between echo requests\nduring path discovery
units: "minute"
default: "240"

  }
}

MULTIPATH - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/multipath/

Update operation of resource: multipath

multipath_schema

multipathbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Downstream map multipath settingsPUTPOSTDELETEGET
    
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTIPATH - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/multipath/

Create operation of resource: multipath

multipath_schema

multipathbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Downstream map multipath settingsPUTPOSTDELETEGET
    
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTIPATH - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/multipath/

Delete operation of resource: multipath

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MULTIPATH - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/path-discover/echo/multipath/

Retrieve operation of resource: multipath

monitor-id: string
in path

ID of monitor-id

200 OK
multipath_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Downstream map multipath settingsPUTPOSTDELETEGET
    
"bitmap-size": "integer" Multipath bit size
range: "1..256"
default: "32"

  }
}

REPLY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/reply/

Update operation of resource: reply

reply_schema

replybody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/reply/

Create operation of resource: reply

reply_schema

replybody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/reply/

Delete operation of resource: reply

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/reply/

Retrieve operation of resource: reply

monitor-id: string
in path

ID of monitor-id

200 OK
reply_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/statistics/

Delete operation of resource: statistics

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/statistics/

Retrieve operation of resource: statistics

monitor-id: string
in path

ID of monitor-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

SCAN - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/scan/

Update operation of resource: scan

scan_schema

scanbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Scanning parameters configurationPUTPOSTDELETEGET
    
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCAN - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/scan/

Create operation of resource: scan

scan_schema

scanbody object

monitor-id: string
in path

ID of monitor-id

Request Content-Types: application/json
Request Example
{
  : {
Scanning parameters configurationPUTPOSTDELETEGET
    
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCAN - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/scan/

Delete operation of resource: scan

monitor-id: string
in path

ID of monitor-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCAN - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-lsp-monitor/definitions/definition/{monitor-id}/operation-type/mpls-lsp-ping/scan/

Retrieve operation of resource: scan

monitor-id: string
in path

ID of monitor-id

200 OK
scan_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Scanning parameters configurationPUTPOSTDELETEGET
    
"delete-factor": "integer", Number of times for automatic deletion
range: "0..2147483647"
default: "1"

    
"interval": "integer" Time interval for automatic discovery
units: "minute"
default: "240"

  }
}

OPERATION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/

Update operation of resource: operation

operation_schema

operationbody object

Request Content-Types: application/json
Request Example
{
  : {
IPSLA Operation configurationPUTPOSTDELETEGET
    : {
Reaction trigger configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Reaction configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Reaction condition specificationPUTPOSTDELETEGET
            : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on round trip time threshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on error verfication violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            }
          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Operation definition tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Operation type specificationPUTPOSTDELETEGET
            : {
UDPEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"verify-data": "null", Check each IPSLA response for corruption

              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"dest-port": "string", Port number on target device

              
"control-disable": "null", Disable control packets

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"source-port": "string", Port number on source device

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              }
            },
            : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation
              : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              },
              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
              : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                
"node8": "string", IPv4 address of the intermediate node

                
"node1": "string", IPv4 address of the intermediate node

                
"node3": "string", IPv4 address of the intermediate node

                
"node2": "string", IPv4 address of the intermediate node

                
"node5": "string", IPv4 address of the intermediate node

                
"node4": "string", IPv4 address of the intermediate node

                
"node7": "string", IPv4 address of the intermediate node

                
"node6": "string" IPv4 address of the intermediate node

              },
              
"dest-address": "string" Enter IPv4 address of the destination device

            },
            : {
UDPJitter Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"verify-data": "null", Check each IPSLA response for corruption

              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation
              : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              },
              
"control-disable": "null", Disable control packets

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"source-port": "string", Port number on source device

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              
"dest-port": "string" Port number on target device

            },
            : {
ICMPEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"dest-address": "string", Enter IPv4 address of the destination device

              
"source-address-v6": "string", Enter IPv6 address of the source device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              }
            },
            : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                  : {
Target FEC address with maskPUTPOSTDELETEGET
                    
"mask": "string", IP netmask for target

                    
"address": "string" IP address for target

                  }
                },
                : {
Traffic engineering targetPUTPOSTDELETEGET
                  
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                }
              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"create": "null", Create operation with specified type

              
"tag": "string", Add a tag for this operation

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              },
              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            },
            : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

                
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                
"node8": "string", IPv4 address of the intermediate node

                
"node1": "string", IPv4 address of the intermediate node

                
"node3": "string", IPv4 address of the intermediate node

                
"node2": "string", IPv4 address of the intermediate node

                
"node5": "string", IPv4 address of the intermediate node

                
"node4": "string", IPv4 address of the intermediate node

                
"node7": "string", IPv4 address of the intermediate node

                
"node6": "string" IPv4 address of the intermediate node

              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string", Choose type of data to be stored in history\nbuffer

                
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

              }
            },
            : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                : {
Pseudowire targetPUTPOSTDELETEGET
                  : {
Target addressPUTPOSTDELETEGET
                    
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                    
"address": "string" IP address for target

                  }
                },
                : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                  : {
Target FEC address with maskPUTPOSTDELETEGET
                    
"mask": "string", IP netmask for target

                    
"address": "string" IP address for target

                  }
                },
                : {
Traffic engineering targetPUTPOSTDELETEGET
                  
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                }
              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              },
              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            }
          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Schedule an operationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

          
"life": "string", Length of the time to execute (default 3600\nseconds)

          
"recurring": "null", probe to be scheduled automatically every day
          : {
Start time of the operationPUTPOSTDELETEGET
            
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

            
"month": "string", Month of the year (optional. Default current\nmonth)

            
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

            
"schedule-type": "string", Type of schedule

            
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

            
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

            
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/

Create operation of resource: operation

operation_schema

operationbody object

Request Content-Types: application/json
Request Example
{
  : {
IPSLA Operation configurationPUTPOSTDELETEGET
    : {
Reaction trigger configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Reaction configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Reaction condition specificationPUTPOSTDELETEGET
            : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on round trip time threshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on error verfication violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            }
          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Operation definition tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Operation type specificationPUTPOSTDELETEGET
            : {
UDPEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"verify-data": "null", Check each IPSLA response for corruption

              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"dest-port": "string", Port number on target device

              
"control-disable": "null", Disable control packets

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"source-port": "string", Port number on source device

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              }
            },
            : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation
              : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              },
              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
              : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                
"node8": "string", IPv4 address of the intermediate node

                
"node1": "string", IPv4 address of the intermediate node

                
"node3": "string", IPv4 address of the intermediate node

                
"node2": "string", IPv4 address of the intermediate node

                
"node5": "string", IPv4 address of the intermediate node

                
"node4": "string", IPv4 address of the intermediate node

                
"node7": "string", IPv4 address of the intermediate node

                
"node6": "string" IPv4 address of the intermediate node

              },
              
"dest-address": "string" Enter IPv4 address of the destination device

            },
            : {
UDPJitter Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"verify-data": "null", Check each IPSLA response for corruption

              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation
              : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              },
              
"control-disable": "null", Disable control packets

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"source-port": "string", Port number on source device

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              
"dest-port": "string" Port number on target device

            },
            : {
ICMPEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"dest-address": "string", Enter IPv4 address of the destination device

              
"source-address-v6": "string", Enter IPv6 address of the source device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              }
            },
            : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                  : {
Target FEC address with maskPUTPOSTDELETEGET
                    
"mask": "string", IP netmask for target

                    
"address": "string" IP address for target

                  }
                },
                : {
Traffic engineering targetPUTPOSTDELETEGET
                  
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                }
              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"create": "null", Create operation with specified type

              
"tag": "string", Add a tag for this operation

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              },
              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            },
            : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

                
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                
"node8": "string", IPv4 address of the intermediate node

                
"node1": "string", IPv4 address of the intermediate node

                
"node3": "string", IPv4 address of the intermediate node

                
"node2": "string", IPv4 address of the intermediate node

                
"node5": "string", IPv4 address of the intermediate node

                
"node4": "string", IPv4 address of the intermediate node

                
"node7": "string", IPv4 address of the intermediate node

                
"node6": "string" IPv4 address of the intermediate node

              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string", Choose type of data to be stored in history\nbuffer

                
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

              }
            },
            : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                : {
Pseudowire targetPUTPOSTDELETEGET
                  : {
Target addressPUTPOSTDELETEGET
                    
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                    
"address": "string" IP address for target

                  }
                },
                : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                  : {
Target FEC address with maskPUTPOSTDELETEGET
                    
"mask": "string", IP netmask for target

                    
"address": "string" IP address for target

                  }
                },
                : {
Traffic engineering targetPUTPOSTDELETEGET
                  
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                }
              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              },
              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            }
          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Schedule an operationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

          
"life": "string", Length of the time to execute (default 3600\nseconds)

          
"recurring": "null", probe to be scheduled automatically every day
          : {
Start time of the operationPUTPOSTDELETEGET
            
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

            
"month": "string", Month of the year (optional. Default current\nmonth)

            
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

            
"schedule-type": "string", Type of schedule

            
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

            
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

            
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/

Delete operation of resource: operation

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/

Retrieve operation of resource: operation

200 OK
operation_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
IPSLA Operation configurationPUTPOSTDELETEGET
    : {
Reaction trigger configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Reaction configurationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Reaction condition specificationPUTPOSTDELETEGET
            : {
Probe/Control timeout in millisecondsPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on round trip time threshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
                
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

                
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

              },
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              },
              
"create": "null" Create operation with specified type

            },
            : {
React on error verfication violationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            },
            : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
              : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
                
"thresh-type": "string", Type of thresholding to perform

                
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

                
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

              },
              
"create": "null", Create operation with specified type
              : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
                
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

                
"logging": "null" Generate a syslog alarm on threshold violation

              }
            }
          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Operation definition tablePUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Operation type specificationPUTPOSTDELETEGET
            : {
UDPEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"verify-data": "null", Check each IPSLA response for corruption

              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"dest-port": "string", Port number on target device

              
"control-disable": "null", Disable control packets

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"source-port": "string", Port number on source device

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              }
            },
            : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation
              : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              },
              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
              : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                
"node8": "string", IPv4 address of the intermediate node

                
"node1": "string", IPv4 address of the intermediate node

                
"node3": "string", IPv4 address of the intermediate node

                
"node2": "string", IPv4 address of the intermediate node

                
"node5": "string", IPv4 address of the intermediate node

                
"node4": "string", IPv4 address of the intermediate node

                
"node7": "string", IPv4 address of the intermediate node

                
"node6": "string" IPv4 address of the intermediate node

              },
              
"dest-address": "string" Enter IPv4 address of the destination device

            },
            : {
UDPJitter Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"verify-data": "null", Check each IPSLA response for corruption

              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation
              : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
                
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              },
              
"control-disable": "null", Disable control packets

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"source-port": "string", Port number on source device

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              
"dest-port": "string" Port number on target device

            },
            : {
ICMPEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"dest-address": "string", Enter IPv4 address of the destination device

              
"source-address-v6": "string", Enter IPv6 address of the source device
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              }
            },
            : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                  : {
Target FEC address with maskPUTPOSTDELETEGET
                    
"mask": "string", IP netmask for target

                    
"address": "string" IP address for target

                  }
                },
                : {
Traffic engineering targetPUTPOSTDELETEGET
                  
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                }
              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"create": "null", Create operation with specified type

              
"tag": "string", Add a tag for this operation

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              },
              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            },
            : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

                
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"dest-address": "string", Enter IPv4 address of the destination device
              : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
                
"node8": "string", IPv4 address of the intermediate node

                
"node1": "string", IPv4 address of the intermediate node

                
"node3": "string", IPv4 address of the intermediate node

                
"node2": "string", IPv4 address of the intermediate node

                
"node5": "string", IPv4 address of the intermediate node

                
"node4": "string", IPv4 address of the intermediate node

                
"node7": "string", IPv4 address of the intermediate node

                
"node6": "string" IPv4 address of the intermediate node

              },
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string", Choose type of data to be stored in history\nbuffer

                
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

              }
            },
            : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
              : {
Table of statistics collection intervalsPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                    
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                  }
                ]
              },
              : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
                
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

                
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

                
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

              },
              : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
                : {
Pseudowire targetPUTPOSTDELETEGET
                  : {
Target addressPUTPOSTDELETEGET
                    
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                    
"address": "string" IP address for target

                  }
                },
                : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                  : {
Target FEC address with maskPUTPOSTDELETEGET
                    
"mask": "string", IP netmask for target

                    
"address": "string" IP address for target

                  }
                },
                : {
Traffic engineering targetPUTPOSTDELETEGET
                  
"tunnel": "integer" Tunnel interface number
range: "0..65535"

                }
              },
              
"source-address": "string", Enter IPv4 address of the source device

              
"create": "null", Create operation with specified type
              : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
                
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

              },
              
"tag": "string", Add a tag for this operation

              
"output-interface": "string", Echo request output interface

              
"output-nexthop": "string", Echo request output nexthop

              
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

              
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

              
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
              : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
                
"mode": "string", Enables use of router alert in echo reply\npackets

                
"dscp-bits": "string" DSCP bits in the reply IP header

              },
              
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
              : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

                
"history-filter": "string" Choose type of data to be stored in history\nbuffer

              },
              
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

              
"force-explicit-null": "null" Forced option for the MPLS LSP operation

            }
          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    },
    : {
Schedule an operationPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

          
"life": "string", Length of the time to execute (default 3600\nseconds)

          
"recurring": "null", probe to be scheduled automatically every day
          : {
Start time of the operationPUTPOSTDELETEGET
            
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

            
"month": "string", Month of the year (optional. Default current\nmonth)

            
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

            
"schedule-type": "string", Type of schedule

            
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

            
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

            
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

          },
          
"operation-id": "integer" Operation number
range: "1..2048"

        }
      ]
    }
  }
}

SCHEDULES - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/

Update operation of resource: schedules

schedules_schema

schedulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Schedule an operationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

        
"life": "string", Length of the time to execute (default 3600\nseconds)

        
"recurring": "null", probe to be scheduled automatically every day
        : {
Start time of the operationPUTPOSTDELETEGET
          
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

          
"month": "string", Month of the year (optional. Default current\nmonth)

          
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

          
"schedule-type": "string", Type of schedule

          
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

          
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

          
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULES - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/

Create operation of resource: schedules

schedules_schema

schedulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Schedule an operationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

        
"life": "string", Length of the time to execute (default 3600\nseconds)

        
"recurring": "null", probe to be scheduled automatically every day
        : {
Start time of the operationPUTPOSTDELETEGET
          
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

          
"month": "string", Month of the year (optional. Default current\nmonth)

          
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

          
"schedule-type": "string", Type of schedule

          
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

          
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

          
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULES - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/

Delete operation of resource: schedules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULES - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/

Retrieve operation of resource: schedules

200 OK
schedules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Schedule an operationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

        
"life": "string", Length of the time to execute (default 3600\nseconds)

        
"recurring": "null", probe to be scheduled automatically every day
        : {
Start time of the operationPUTPOSTDELETEGET
          
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

          
"month": "string", Month of the year (optional. Default current\nmonth)

          
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

          
"schedule-type": "string", Type of schedule

          
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

          
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

          
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}

SCHEDULE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/

Update operation of resource: schedule

schedule_schema

schedulebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

      
"life": "string", Length of the time to execute (default 3600\nseconds)

      
"recurring": "null", probe to be scheduled automatically every day
      : {
Start time of the operationPUTPOSTDELETEGET
        
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

        
"month": "string", Month of the year (optional. Default current\nmonth)

        
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

        
"schedule-type": "string", Type of schedule

        
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

        
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

        
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/

Create operation of resource: schedule

schedule_schema

schedulebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

      
"life": "string", Length of the time to execute (default 3600\nseconds)

      
"recurring": "null", probe to be scheduled automatically every day
      : {
Start time of the operationPUTPOSTDELETEGET
        
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

        
"month": "string", Month of the year (optional. Default current\nmonth)

        
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

        
"schedule-type": "string", Type of schedule

        
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

        
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

        
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/

Delete operation of resource: schedule

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEDULE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/

Retrieve operation of resource: schedule

operation-id: string
in path

ID of operation-id

200 OK
schedule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"ageout": "integer", How long to keep this entry after it becomes\ninactive
range: "0..2073600"
units: "second"

      
"life": "string", Length of the time to execute (default 3600\nseconds)

      
"recurring": "null", probe to be scheduled automatically every day
      : {
Start time of the operationPUTPOSTDELETEGET
        
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

        
"month": "string", Month of the year (optional. Default current\nmonth)

        
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

        
"schedule-type": "string", Type of schedule

        
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

        
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

        
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}

START-TIME - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/start-time/

Update operation of resource: start-time

start-time_schema

start-timebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Start time of the operationPUTPOSTDELETEGET
    
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

    
"month": "string", Month of the year (optional. Default current\nmonth)

    
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

    
"schedule-type": "string", Type of schedule

    
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

    
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

    
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

START-TIME - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/start-time/

Create operation of resource: start-time

start-time_schema

start-timebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Start time of the operationPUTPOSTDELETEGET
    
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

    
"month": "string", Month of the year (optional. Default current\nmonth)

    
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

    
"schedule-type": "string", Type of schedule

    
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

    
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

    
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

START-TIME - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/start-time/

Delete operation of resource: start-time

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

START-TIME - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/schedules/schedule/{operation-id}/start-time/

Retrieve operation of resource: start-time

operation-id: string
in path

ID of operation-id

200 OK
start-time_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Start time of the operationPUTPOSTDELETEGET
    
"hour": "integer", Hour value(hh) in hh:mm:ss specification
range: "0..23"

    
"month": "string", Month of the year (optional. Default current\nmonth)

    
"second": "integer", Second value(ss) in hh:mm:ss specification
range: "0..59"

    
"schedule-type": "string", Type of schedule

    
"year": "integer", Year(optional. Default current year)
range: "1993..2035"

    
"day": "integer", Day of the month(optional. Default today)
range: "1..31"

    
"minute": "integer" Minute value(mm) in hh:mm:ss specification
range: "0..59"

  }
}

REACTIONS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/

Update operation of resource: reactions

reactions_schema

reactionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Reaction configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Reaction condition specificationPUTPOSTDELETEGET
          : {
React on probe timeoutPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on round trip time threshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on error verfication violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTIONS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/

Create operation of resource: reactions

reactions_schema

reactionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Reaction configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Reaction condition specificationPUTPOSTDELETEGET
          : {
React on probe timeoutPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on round trip time threshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on error verfication violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTIONS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/

Delete operation of resource: reactions

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTIONS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/

Retrieve operation of resource: reactions

200 OK
reactions_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Reaction configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Reaction condition specificationPUTPOSTDELETEGET
          : {
React on probe timeoutPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on round trip time threshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
              
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

              
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

            },
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            },
            
"create": "null" Create reaction condition for a particular\noperation

          },
          : {
React on error verfication violationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          },
          : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
            : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
              
"thresh-type": "string", Type of thresholding to perform

              
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

              
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

            },
            
"create": "null", Create reaction condition for a particular\noperation
            : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
              
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

              
"logging": "null" Generate a syslog alarm on threshold violation

            }
          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}

REACTION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/

Update operation of resource: reaction

reaction_schema

reactionbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Reaction condition specificationPUTPOSTDELETEGET
        : {
React on probe timeoutPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on round trip time threshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on error verfication violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/

Create operation of resource: reaction

reaction_schema

reactionbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Reaction condition specificationPUTPOSTDELETEGET
        : {
React on probe timeoutPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on round trip time threshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on error verfication violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/

Delete operation of resource: reaction

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/

Retrieve operation of resource: reaction

operation-id: string
in path

ID of operation-id

200 OK
reaction_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Reaction condition specificationPUTPOSTDELETEGET
        : {
React on probe timeoutPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on round trip time threshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
            
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

            
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

          },
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          },
          
"create": "null" Create reaction condition for a particular\noperation

        },
        : {
React on error verfication violationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        },
        : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
          : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
            
"thresh-type": "string", Type of thresholding to perform

            
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

            
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

          },
          
"create": "null", Create reaction condition for a particular\noperation
          : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
            
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

            
"logging": "null" Generate a syslog alarm on threshold violation

          }
        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}

CONDITION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/

Update operation of resource: condition

condition_schema

conditionbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Reaction condition specificationPUTPOSTDELETEGET
    : {
React on probe timeoutPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on round trip time threshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on error verfication violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONDITION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/

Create operation of resource: condition

condition_schema

conditionbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Reaction condition specificationPUTPOSTDELETEGET
    : {
React on probe timeoutPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on round trip time threshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on error verfication violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONDITION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/

Delete operation of resource: condition

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONDITION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/

Retrieve operation of resource: condition

operation-id: string
in path

ID of operation-id

200 OK
condition_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Reaction condition specificationPUTPOSTDELETEGET
    : {
React on probe timeoutPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on round trip time threshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
        
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

        
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

      },
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      },
      
"create": "null" Create reaction condition for a particular\noperation

    },
    : {
React on error verfication violationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    },
    : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
      : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
        
"thresh-type": "string", Type of thresholding to perform

        
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

        
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

      },
      
"create": "null", Create reaction condition for a particular\noperation
      : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
        
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

        
"logging": "null" Generate a syslog alarm on threshold violation

      }
    }
  }
}

JITTER-AVERAGE-DS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/

Update operation of resource: jitter-average-ds

jitter-average-ds_schema

jitter-average-dsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE-DS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/

Create operation of resource: jitter-average-ds

jitter-average-ds_schema

jitter-average-dsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE-DS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/

Delete operation of resource: jitter-average-ds

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE-DS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/

Retrieve operation of resource: jitter-average-ds

operation-id: string
in path

ID of operation-id

200 OK
jitter-average-ds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on destination to source jitter\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}

THRESHOLD-LIMITS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-limits/

Update operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-limits/

Create operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-limits/

Delete operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-limits/

Retrieve operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK
threshold-limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-ds/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

TIMEOUT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/

Update operation of resource: timeout

timeout_schema

timeoutbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on probe timeoutPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/

Create operation of resource: timeout

timeout_schema

timeoutbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on probe timeoutPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/

Delete operation of resource: timeout

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/

Retrieve operation of resource: timeout

operation-id: string
in path

ID of operation-id

200 OK
timeout_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on probe timeoutPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/timeout/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

JITTER-AVERAGE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/

Update operation of resource: jitter-average

jitter-average_schema

jitter-averagebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/

Create operation of resource: jitter-average

jitter-average_schema

jitter-averagebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/

Delete operation of resource: jitter-average

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/

Retrieve operation of resource: jitter-average

operation-id: string
in path

ID of operation-id

200 OK
jitter-average_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on average round trip jitter threshold\nviolationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}

THRESHOLD-LIMITS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-limits/

Update operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-limits/

Create operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-limits/

Delete operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-limits/

Retrieve operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK
threshold-limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

VERIFY-ERROR - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/

Update operation of resource: verify-error

verify-error_schema

verify-errorbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on error verfication violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERIFY-ERROR - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/

Create operation of resource: verify-error

verify-error_schema

verify-errorbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on error verfication violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERIFY-ERROR - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/

Delete operation of resource: verify-error

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERIFY-ERROR - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/

Retrieve operation of resource: verify-error

operation-id: string
in path

ID of operation-id

200 OK
verify-error_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on error verfication violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/verify-error/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

RTT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/

Update operation of resource: rtt

rtt_schema

rttbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on round trip time threshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RTT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/

Create operation of resource: rtt

rtt_schema

rttbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on round trip time threshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RTT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/

Delete operation of resource: rtt

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RTT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/

Retrieve operation of resource: rtt

operation-id: string
in path

ID of operation-id

200 OK
rtt_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on round trip time threshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}

THRESHOLD-LIMITS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-limits/

Update operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-limits/

Create operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-limits/

Delete operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-limits/

Retrieve operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK
threshold-limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/rtt/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

PACKET-LOSS-SD - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/

Update operation of resource: packet-loss-sd

packet-loss-sd_schema

packet-loss-sdbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-LOSS-SD - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/

Create operation of resource: packet-loss-sd

packet-loss-sd_schema

packet-loss-sdbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-LOSS-SD - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/

Delete operation of resource: packet-loss-sd

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-LOSS-SD - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/

Retrieve operation of resource: packet-loss-sd

operation-id: string
in path

ID of operation-id

200 OK
packet-loss-sd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on destination to source packet loss\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}

THRESHOLD-LIMITS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-limits/

Update operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-limits/

Create operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-limits/

Delete operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-limits/

Retrieve operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK
threshold-limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-sd/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

JITTER-AVERAGE-SD - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/

Update operation of resource: jitter-average-sd

jitter-average-sd_schema

jitter-average-sdbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE-SD - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/

Create operation of resource: jitter-average-sd

jitter-average-sd_schema

jitter-average-sdbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE-SD - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/

Delete operation of resource: jitter-average-sd

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

JITTER-AVERAGE-SD - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/

Retrieve operation of resource: jitter-average-sd

operation-id: string
in path

ID of operation-id

200 OK
jitter-average-sd_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on average source to destination\njitter threshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}

THRESHOLD-LIMITS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-limits/

Update operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-limits/

Create operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-limits/

Delete operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-limits/

Retrieve operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK
threshold-limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/jitter-average-sd/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

CONNECTION-LOSS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/

Update operation of resource: connection-loss

connection-loss_schema

connection-lossbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTION-LOSS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/

Create operation of resource: connection-loss

connection-loss_schema

connection-lossbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTION-LOSS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/

Delete operation of resource: connection-loss

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONNECTION-LOSS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/

Retrieve operation of resource: connection-loss

operation-id: string
in path

ID of operation-id

200 OK
connection-loss_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on connection loss for a monitored\noperationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    
"create": "null", Create reaction condition for a particular\noperation
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    }
  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/connection-loss/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

PACKET-LOSS-DS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/

Update operation of resource: packet-loss-ds

packet-loss-ds_schema

packet-loss-dsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-LOSS-DS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/

Create operation of resource: packet-loss-ds

packet-loss-ds_schema

packet-loss-dsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-LOSS-DS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/

Delete operation of resource: packet-loss-ds

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET-LOSS-DS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/

Retrieve operation of resource: packet-loss-ds

operation-id: string
in path

ID of operation-id

200 OK
packet-loss-ds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
React on source to destination packet loss\nthreshold violationPUTPOSTDELETEGET
    : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
      
"thresh-type": "string", Type of thresholding to perform

      
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

      
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

    },
    : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
      
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

      
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

    },
    : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
      
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

      
"logging": "null" Generate a syslog alarm on threshold violation

    },
    
"create": "null" Create reaction condition for a particular\noperation

  }
}

THRESHOLD-LIMITS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-limits/

Update operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-limits/

Create operation of resource: threshold-limits

threshold-limits_schema

threshold-limitsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-limits/

Delete operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-LIMITS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-limits/

Retrieve operation of resource: threshold-limits

operation-id: string
in path

ID of operation-id

200 OK
threshold-limits_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify threshold limits for the monitored\nelementPUTPOSTDELETEGET
    
"upper-limit": "integer", Threshold upper limit value
range: "1..4294967295"

    
"lower-limit": "integer" Threshold lower limit value
range: "1..4294967295"

  }
}

ACTION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/action-type/

Update operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/action-type/

Create operation of resource: action-type

action-type_schema

action-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/action-type/

Delete operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ACTION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/action-type/

Retrieve operation of resource: action-type

operation-id: string
in path

ID of operation-id

200 OK
action-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of action to be taken on threshold\nviolation(s)PUTPOSTDELETEGET
    
"trigger": "null", Generate trigger to active reaction triggered\noperation(s)

    
"logging": "null" Generate a syslog alarm on threshold violation

  }
}

THRESHOLD-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-type/

Update operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-type/

Create operation of resource: threshold-type

threshold-type_schema

threshold-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-type/

Delete operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reactions/reaction/{operation-id}/condition/packet-loss-ds/threshold-type/

Retrieve operation of resource: threshold-type

operation-id: string
in path

ID of operation-id

200 OK
threshold-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of thresholding to perform on the monitored\nelementPUTPOSTDELETEGET
    
"thresh-type": "string", Type of thresholding to perform

    
"count1": "integer", Probe count for avarage, consecutive case or X\nvalue for XofY case
range: "1..16"

    
"count2": "integer" Y value, when threshold type is XofY
range: "1..16"

  }
}

REACTION-TRIGGERS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/

Update operation of resource: reaction-triggers

reaction-triggers_schema

reaction-triggersbody object

Request Content-Types: application/json
Request Example
{
  : {
Reaction trigger configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

        
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION-TRIGGERS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/

Create operation of resource: reaction-triggers

reaction-triggers_schema

reaction-triggersbody object

Request Content-Types: application/json
Request Example
{
  : {
Reaction trigger configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

        
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION-TRIGGERS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/

Delete operation of resource: reaction-triggers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION-TRIGGERS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/

Retrieve operation of resource: reaction-triggers

200 OK
reaction-triggers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Reaction trigger configurationPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

        
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"

      }
    ]
  }
}

REACTION-TRIGGER - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/reaction-trigger/{operation-id}/

Update operation of resource: reaction-trigger

reaction-trigger_schema

reaction-triggerbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

      
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION-TRIGGER - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/reaction-trigger/{operation-id}/

Create operation of resource: reaction-trigger

reaction-trigger_schema

reaction-triggerbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

      
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION-TRIGGER - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/reaction-trigger/{operation-id}/

Delete operation of resource: reaction-trigger

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REACTION-TRIGGER - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/reaction-triggers/reaction-trigger/{operation-id}/

Retrieve operation of resource: reaction-trigger

operation-id: string
in path

ID of operation-id

200 OK
reaction-trigger_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"triggered-op-id": "integer", Operation number of the operation to be\ntriggered
range: "1..2048"

      
"operation-id": "integer" Operation number of the operation generating\na trigger
range: "1..2048"

    }
  ]
}

DEFINITIONS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/

Update operation of resource: definitions

definitions_schema

definitionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Operation definition tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Operation type specificationPUTPOSTDELETEGET
          : {
UDPEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"dest-port": "string", Port number on target device

            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
            : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            
"dest-address": "string" Enter IPv4 address of the destination device

          },
          : {
UDPJitter Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            
"dest-port": "string" Port number on target device

          },
          : {
ICMPEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device

            
"source-address-v6": "string", Enter IPv6 address of the source device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
              : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                : {
Target FEC address with maskPUTPOSTDELETEGET
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering targetPUTPOSTDELETEGET
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type

            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          },
          : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

              
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string", Choose type of data to be stored in history\nbuffer

              
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

            }
          },
          : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
              : {
Pseudowire targetPUTPOSTDELETEGET
                : {
Target addressPUTPOSTDELETEGET
                  
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                  
"address": "string" IP address for target

                }
              },
              : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                : {
Target FEC address with maskPUTPOSTDELETEGET
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering targetPUTPOSTDELETEGET
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITIONS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/

Create operation of resource: definitions

definitions_schema

definitionsbody object

Request Content-Types: application/json
Request Example
{
  : {
Operation definition tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Operation type specificationPUTPOSTDELETEGET
          : {
UDPEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"dest-port": "string", Port number on target device

            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
            : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            
"dest-address": "string" Enter IPv4 address of the destination device

          },
          : {
UDPJitter Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            
"dest-port": "string" Port number on target device

          },
          : {
ICMPEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device

            
"source-address-v6": "string", Enter IPv6 address of the source device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
              : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                : {
Target FEC address with maskPUTPOSTDELETEGET
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering targetPUTPOSTDELETEGET
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type

            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          },
          : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

              
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string", Choose type of data to be stored in history\nbuffer

              
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

            }
          },
          : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
              : {
Pseudowire targetPUTPOSTDELETEGET
                : {
Target addressPUTPOSTDELETEGET
                  
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                  
"address": "string" IP address for target

                }
              },
              : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                : {
Target FEC address with maskPUTPOSTDELETEGET
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering targetPUTPOSTDELETEGET
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITIONS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/

Delete operation of resource: definitions

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITIONS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/

Retrieve operation of resource: definitions

200 OK
definitions_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Operation definition tablePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Operation type specificationPUTPOSTDELETEGET
          : {
UDPEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"dest-port": "string", Port number on target device

            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
            : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            
"dest-address": "string" Enter IPv4 address of the destination device

          },
          : {
UDPJitter Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"verify-data": "null", Check each IPSLA response for corruption

            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation
            : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
              
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

              
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

            },
            
"control-disable": "null", Disable control packets

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"source-port": "string", Port number on source device

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            
"dest-port": "string" Port number on target device

          },
          : {
ICMPEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device

            
"source-address-v6": "string", Enter IPv6 address of the source device
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            }
          },
          : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
              : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                : {
Target FEC address with maskPUTPOSTDELETEGET
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering targetPUTPOSTDELETEGET
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type

            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          },
          : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

              
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"dest-address": "string", Enter IPv4 address of the destination device
            : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
              
"node8": "string", IPv4 address of the intermediate node

              
"node1": "string", IPv4 address of the intermediate node

              
"node3": "string", IPv4 address of the intermediate node

              
"node2": "string", IPv4 address of the intermediate node

              
"node5": "string", IPv4 address of the intermediate node

              
"node4": "string", IPv4 address of the intermediate node

              
"node7": "string", IPv4 address of the intermediate node

              
"node6": "string" IPv4 address of the intermediate node

            },
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string", Choose type of data to be stored in history\nbuffer

              
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

            }
          },
          : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
            : {
Table of statistics collection intervalsPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                  
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

                }
              ]
            },
            : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
              
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

              
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

              
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

            },
            : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
              : {
Pseudowire targetPUTPOSTDELETEGET
                : {
Target addressPUTPOSTDELETEGET
                  
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                  
"address": "string" IP address for target

                }
              },
              : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
                : {
Target FEC address with maskPUTPOSTDELETEGET
                  
"mask": "string", IP netmask for target

                  
"address": "string" IP address for target

                }
              },
              : {
Traffic engineering targetPUTPOSTDELETEGET
                
"tunnel": "integer" Tunnel interface number
range: "0..65535"

              }
            },
            
"source-address": "string", Enter IPv4 address of the source device

            
"create": "null", Create operation with specified type
            : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
              
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

            },
            
"tag": "string", Add a tag for this operation

            
"output-interface": "string", Echo request output interface

            
"output-nexthop": "string", Echo request output nexthop

            
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

            
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

            
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
            : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
              
"mode": "string", Enables use of router alert in echo reply\npackets

              
"dscp-bits": "string" DSCP bits in the reply IP header

            },
            
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
            : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
              
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

              
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

              
"history-filter": "string" Choose type of data to be stored in history\nbuffer

            },
            
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

            
"force-explicit-null": "null" Forced option for the MPLS LSP operation

          }
        },
        
"operation-id": "integer" Operation number
range: "1..2048"

      }
    ]
  }
}

DEFINITION - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/

Update operation of resource: definition

definition_schema

definitionbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Operation type specificationPUTPOSTDELETEGET
        : {
UDPEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"dest-port": "string", Port number on target device

          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
          : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          
"dest-address": "string" Enter IPv4 address of the destination device

        },
        : {
UDPJitter Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          
"dest-port": "string" Port number on target device

        },
        : {
ICMPEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device

          
"source-address-v6": "string", Enter IPv6 address of the source device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
            : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
              : {
Target FEC address with maskPUTPOSTDELETEGET
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering targetPUTPOSTDELETEGET
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type

          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        },
        : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

            
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string", Choose type of data to be stored in history\nbuffer

            
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

          }
        },
        : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
            : {
Pseudowire targetPUTPOSTDELETEGET
              : {
Target addressPUTPOSTDELETEGET
                
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                
"address": "string" IP address for target

              }
            },
            : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
              : {
Target FEC address with maskPUTPOSTDELETEGET
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering targetPUTPOSTDELETEGET
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITION - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/

Create operation of resource: definition

definition_schema

definitionbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Operation type specificationPUTPOSTDELETEGET
        : {
UDPEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"dest-port": "string", Port number on target device

          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
          : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          
"dest-address": "string" Enter IPv4 address of the destination device

        },
        : {
UDPJitter Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          
"dest-port": "string" Port number on target device

        },
        : {
ICMPEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device

          
"source-address-v6": "string", Enter IPv6 address of the source device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
            : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
              : {
Target FEC address with maskPUTPOSTDELETEGET
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering targetPUTPOSTDELETEGET
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type

          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        },
        : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

            
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string", Choose type of data to be stored in history\nbuffer

            
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

          }
        },
        : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
            : {
Pseudowire targetPUTPOSTDELETEGET
              : {
Target addressPUTPOSTDELETEGET
                
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                
"address": "string" IP address for target

              }
            },
            : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
              : {
Target FEC address with maskPUTPOSTDELETEGET
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering targetPUTPOSTDELETEGET
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITION - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/

Delete operation of resource: definition

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFINITION - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/

Retrieve operation of resource: definition

operation-id: string
in path

ID of operation-id

200 OK
definition_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Operation type specificationPUTPOSTDELETEGET
        : {
UDPEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"dest-port": "string", Port number on target device

          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
          : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          
"dest-address": "string" Enter IPv4 address of the destination device

        },
        : {
UDPJitter Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"verify-data": "null", Check each IPSLA response for corruption

          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation
          : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
            
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          },
          
"control-disable": "null", Disable control packets

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"source-port": "string", Port number on source device

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          
"dest-port": "string" Port number on target device

        },
        : {
ICMPEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device

          
"source-address-v6": "string", Enter IPv6 address of the source device
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          }
        },
        : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
            : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
              : {
Target FEC address with maskPUTPOSTDELETEGET
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering targetPUTPOSTDELETEGET
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type

          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        },
        : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

            
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"dest-address": "string", Enter IPv4 address of the destination device
          : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
            
"node8": "string", IPv4 address of the intermediate node

            
"node1": "string", IPv4 address of the intermediate node

            
"node3": "string", IPv4 address of the intermediate node

            
"node2": "string", IPv4 address of the intermediate node

            
"node5": "string", IPv4 address of the intermediate node

            
"node4": "string", IPv4 address of the intermediate node

            
"node7": "string", IPv4 address of the intermediate node

            
"node6": "string" IPv4 address of the intermediate node

          },
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string", Choose type of data to be stored in history\nbuffer

            
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

          }
        },
        : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
          : {
Table of statistics collection intervalsPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

                
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

              }
            ]
          },
          : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
            
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

            
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

            
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

          },
          : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
            : {
Pseudowire targetPUTPOSTDELETEGET
              : {
Target addressPUTPOSTDELETEGET
                
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

                
"address": "string" IP address for target

              }
            },
            : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
              : {
Target FEC address with maskPUTPOSTDELETEGET
                
"mask": "string", IP netmask for target

                
"address": "string" IP address for target

              }
            },
            : {
Traffic engineering targetPUTPOSTDELETEGET
              
"tunnel": "integer" Tunnel interface number
range: "0..65535"

            }
          },
          
"source-address": "string", Enter IPv4 address of the source device

          
"create": "null", Create operation with specified type
          : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
            
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

          },
          
"tag": "string", Add a tag for this operation

          
"output-interface": "string", Echo request output interface

          
"output-nexthop": "string", Echo request output nexthop

          
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

          
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
          : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
            
"mode": "string", Enables use of router alert in echo reply\npackets

            
"dscp-bits": "string" DSCP bits in the reply IP header

          },
          
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
          : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

            
"history-filter": "string" Choose type of data to be stored in history\nbuffer

          },
          
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

          
"force-explicit-null": "null" Forced option for the MPLS LSP operation

        }
      },
      
"operation-id": "integer" Operation number
range: "1..2048"

    }
  ]
}

OPERATION-TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/

Update operation of resource: operation-type

operation-type_schema

operation-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Operation type specificationPUTPOSTDELETEGET
    : {
UDPEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"dest-port": "string", Port number on target device

      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
      : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      
"dest-address": "string" Enter IPv4 address of the destination device

    },
    : {
UDPJitter Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      
"dest-port": "string" Port number on target device

    },
    : {
ICMPEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device

      
"source-address-v6": "string", Enter IPv6 address of the source device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
        : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
          : {
Target FEC address with maskPUTPOSTDELETEGET
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering targetPUTPOSTDELETEGET
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type

      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    },
    : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

        
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string", Choose type of data to be stored in history\nbuffer

        
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

      }
    },
    : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
        : {
Pseudowire targetPUTPOSTDELETEGET
          : {
Target addressPUTPOSTDELETEGET
            
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

            
"address": "string" IP address for target

          }
        },
        : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
          : {
Target FEC address with maskPUTPOSTDELETEGET
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering targetPUTPOSTDELETEGET
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION-TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/

Create operation of resource: operation-type

operation-type_schema

operation-typebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Operation type specificationPUTPOSTDELETEGET
    : {
UDPEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"dest-port": "string", Port number on target device

      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
      : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      
"dest-address": "string" Enter IPv4 address of the destination device

    },
    : {
UDPJitter Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      
"dest-port": "string" Port number on target device

    },
    : {
ICMPEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device

      
"source-address-v6": "string", Enter IPv6 address of the source device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
        : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
          : {
Target FEC address with maskPUTPOSTDELETEGET
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering targetPUTPOSTDELETEGET
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type

      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    },
    : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

        
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string", Choose type of data to be stored in history\nbuffer

        
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

      }
    },
    : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
        : {
Pseudowire targetPUTPOSTDELETEGET
          : {
Target addressPUTPOSTDELETEGET
            
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

            
"address": "string" IP address for target

          }
        },
        : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
          : {
Target FEC address with maskPUTPOSTDELETEGET
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering targetPUTPOSTDELETEGET
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION-TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/

Delete operation of resource: operation-type

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPERATION-TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/

Retrieve operation of resource: operation-type

operation-id: string
in path

ID of operation-id

200 OK
operation-type_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Operation type specificationPUTPOSTDELETEGET
    : {
UDPEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"dest-port": "string", Port number on target device

      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
      : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      
"dest-address": "string" Enter IPv4 address of the destination device

    },
    : {
UDPJitter Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"verify-data": "null", Check each IPSLA response for corruption

      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation
      : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
        
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      },
      
"control-disable": "null", Disable control packets

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"source-port": "string", Port number on source device

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      
"dest-port": "string" Port number on target device

    },
    : {
ICMPEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device

      
"source-address-v6": "string", Enter IPv6 address of the source device
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      }
    },
    : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
        : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
          : {
Target FEC address with maskPUTPOSTDELETEGET
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering targetPUTPOSTDELETEGET
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type

      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    },
    : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

        
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"dest-address": "string", Enter IPv4 address of the destination device
      : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
        
"node8": "string", IPv4 address of the intermediate node

        
"node1": "string", IPv4 address of the intermediate node

        
"node3": "string", IPv4 address of the intermediate node

        
"node2": "string", IPv4 address of the intermediate node

        
"node5": "string", IPv4 address of the intermediate node

        
"node4": "string", IPv4 address of the intermediate node

        
"node7": "string", IPv4 address of the intermediate node

        
"node6": "string" IPv4 address of the intermediate node

      },
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string", Choose type of data to be stored in history\nbuffer

        
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

      }
    },
    : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
      : {
Table of statistics collection intervalsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

            
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

          }
        ]
      },
      : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
        
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

        
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

        
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

      },
      : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
        : {
Pseudowire targetPUTPOSTDELETEGET
          : {
Target addressPUTPOSTDELETEGET
            
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

            
"address": "string" IP address for target

          }
        },
        : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
          : {
Target FEC address with maskPUTPOSTDELETEGET
            
"mask": "string", IP netmask for target

            
"address": "string" IP address for target

          }
        },
        : {
Traffic engineering targetPUTPOSTDELETEGET
          
"tunnel": "integer" Tunnel interface number
range: "0..65535"

        }
      },
      
"source-address": "string", Enter IPv4 address of the source device

      
"create": "null", Create operation with specified type
      : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
        
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

      },
      
"tag": "string", Add a tag for this operation

      
"output-interface": "string", Echo request output interface

      
"output-nexthop": "string", Echo request output nexthop

      
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

      
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
      : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
        
"mode": "string", Enables use of router alert in echo reply\npackets

        
"dscp-bits": "string" DSCP bits in the reply IP header

      },
      
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
      : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
        
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

        
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

        
"history-filter": "string" Choose type of data to be stored in history\nbuffer

      },
      
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

      
"force-explicit-null": "null" Forced option for the MPLS LSP operation

    }
  }
}

ICMP-ECHO - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/

Update operation of resource: icmp-echo

icmp-echo_schema

icmp-echobody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
ICMPEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"dest-address": "string", Enter IPv4 address of the destination device

    
"source-address-v6": "string", Enter IPv6 address of the source device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-ECHO - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/

Create operation of resource: icmp-echo

icmp-echo_schema

icmp-echobody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
ICMPEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"dest-address": "string", Enter IPv4 address of the destination device

    
"source-address-v6": "string", Enter IPv6 address of the source device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-ECHO - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/

Delete operation of resource: icmp-echo

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-ECHO - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/

Retrieve operation of resource: icmp-echo

operation-id: string
in path

ID of operation-id

200 OK
icmp-echo_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
ICMPEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"dest-address-v6": "string", Enter IPv6 address of the destination\ndevice

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"dest-address": "string", Enter IPv4 address of the destination device

    
"source-address-v6": "string", Enter IPv6 address of the source device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    }
  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/data-size/

Delete operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/data-size/

Retrieve operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/statistics/

Delete operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/statistics/

Retrieve operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

HISTORY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/history/

Update operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/history/

Create operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/history/

Delete operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/history/

Retrieve operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK
history_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}

ENHANCED-STATS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/

Update operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/

Create operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/

Delete operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/

Retrieve operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK
enhanced-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}

ENHANCED-STAT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/enhanced-stat/{interval}/

Update operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/enhanced-stat/{interval}/

Create operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/enhanced-stat/{interval}/

Delete operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-echo/enhanced-stats/enhanced-stat/{interval}/

Retrieve operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK
enhanced-stat_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}

MPLS-LSP-PING - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/

Update operation of resource: mpls-lsp-ping

mpls-lsp-ping_schema

mpls-lsp-pingbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
      : {
Pseudowire targetPUTPOSTDELETEGET
        : {
Target addressPUTPOSTDELETEGET
          
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

          
"address": "string" IP address for target

        }
      },
      : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
        : {
Target FEC address with maskPUTPOSTDELETEGET
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering targetPUTPOSTDELETEGET
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-PING - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/

Create operation of resource: mpls-lsp-ping

mpls-lsp-ping_schema

mpls-lsp-pingbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
      : {
Pseudowire targetPUTPOSTDELETEGET
        : {
Target addressPUTPOSTDELETEGET
          
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

          
"address": "string" IP address for target

        }
      },
      : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
        : {
Target FEC address with maskPUTPOSTDELETEGET
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering targetPUTPOSTDELETEGET
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-PING - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/

Delete operation of resource: mpls-lsp-ping

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-PING - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/

Retrieve operation of resource: mpls-lsp-ping

operation-id: string
in path

ID of operation-id

200 OK
mpls-lsp-ping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
MPLS LSP Ping Operation typePUTPOSTDELETEGET
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
      : {
Pseudowire targetPUTPOSTDELETEGET
        : {
Target addressPUTPOSTDELETEGET
          
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

          
"address": "string" IP address for target

        }
      },
      : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
        : {
Target FEC address with maskPUTPOSTDELETEGET
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering targetPUTPOSTDELETEGET
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/data-size/

Delete operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/data-size/

Retrieve operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

REPLY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/reply/

Update operation of resource: reply

reply_schema

replybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/reply/

Create operation of resource: reply

reply_schema

replybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/reply/

Delete operation of resource: reply

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/reply/

Retrieve operation of resource: reply

operation-id: string
in path

ID of operation-id

200 OK
reply_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}

TARGET - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/

Update operation of resource: target

target_schema

targetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
    : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
      : {
Target FEC address with maskPUTPOSTDELETEGET
        
"mask": "string", IP netmask for target

        
"address": "string" IP address for target

      }
    },
    : {
Traffic engineering targetPUTPOSTDELETEGET
      
"tunnel": "integer" Tunnel interface number
range: "0..65535"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/

Create operation of resource: target

target_schema

targetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
    : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
      : {
Target FEC address with maskPUTPOSTDELETEGET
        
"mask": "string", IP netmask for target

        
"address": "string" IP address for target

      }
    },
    : {
Traffic engineering targetPUTPOSTDELETEGET
      
"tunnel": "integer" Tunnel interface number
range: "0..65535"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/

Delete operation of resource: target

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/

Retrieve operation of resource: target

operation-id: string
in path

ID of operation-id

200 OK
target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
    : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
      : {
Target FEC address with maskPUTPOSTDELETEGET
        
"mask": "string", IP netmask for target

        
"address": "string" IP address for target

      }
    },
    : {
Traffic engineering targetPUTPOSTDELETEGET
      
"tunnel": "integer" Tunnel interface number
range: "0..65535"

    }
  }
}

TRAFFIC-ENGINEERING - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/traffic-engineering/

Update operation of resource: traffic-engineering

traffic-engineering_schema

traffic-engineeringbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Traffic engineering targetPUTPOSTDELETEGET
    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/traffic-engineering/

Create operation of resource: traffic-engineering

traffic-engineering_schema

traffic-engineeringbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Traffic engineering targetPUTPOSTDELETEGET
    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/traffic-engineering/

Delete operation of resource: traffic-engineering

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/traffic-engineering/

Retrieve operation of resource: traffic-engineering

operation-id: string
in path

ID of operation-id

200 OK
traffic-engineering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Traffic engineering targetPUTPOSTDELETEGET
    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

  }
}

IPV4 - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/

Update operation of resource: ipv4

ipv4_schema

ipv4body object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
    : {
Target FEC address with maskPUTPOSTDELETEGET
      
"mask": "string", IP netmask for target

      
"address": "string" IP address for target

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/

Create operation of resource: ipv4

ipv4_schema

ipv4body object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
    : {
Target FEC address with maskPUTPOSTDELETEGET
      
"mask": "string", IP netmask for target

      
"address": "string" IP address for target

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/

Delete operation of resource: ipv4

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/

Retrieve operation of resource: ipv4

operation-id: string
in path

ID of operation-id

200 OK
ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
    : {
Target FEC address with maskPUTPOSTDELETEGET
      
"mask": "string", IP netmask for target

      
"address": "string" IP address for target

    }
  }
}

FEC-ADDRESS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/fec-address/

Update operation of resource: fec-address

fec-address_schema

fec-addressbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target FEC address with maskPUTPOSTDELETEGET
    
"mask": "string", IP netmask for target

    
"address": "string" IP address for target

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FEC-ADDRESS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/fec-address/

Create operation of resource: fec-address

fec-address_schema

fec-addressbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target FEC address with maskPUTPOSTDELETEGET
    
"mask": "string", IP netmask for target

    
"address": "string" IP address for target

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FEC-ADDRESS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/fec-address/

Delete operation of resource: fec-address

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FEC-ADDRESS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/ipv4/fec-address/

Retrieve operation of resource: fec-address

operation-id: string
in path

ID of operation-id

200 OK
fec-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target FEC address with maskPUTPOSTDELETEGET
    
"mask": "string", IP netmask for target

    
"address": "string" IP address for target

  }
}

PSEUDOWIRE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/

Update operation of resource: pseudowire

pseudowire_schema

pseudowirebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Pseudowire targetPUTPOSTDELETEGET
    : {
Target addressPUTPOSTDELETEGET
      
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

      
"address": "string" Target address

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/

Create operation of resource: pseudowire

pseudowire_schema

pseudowirebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Pseudowire targetPUTPOSTDELETEGET
    : {
Target addressPUTPOSTDELETEGET
      
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

      
"address": "string" Target address

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/

Delete operation of resource: pseudowire

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PSEUDOWIRE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/

Retrieve operation of resource: pseudowire

operation-id: string
in path

ID of operation-id

200 OK
pseudowire_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Pseudowire targetPUTPOSTDELETEGET
    : {
Target addressPUTPOSTDELETEGET
      
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

      
"address": "string" Target address

    }
  }
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/target-address/

Update operation of resource: target-address

target-address_schema

target-addressbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target addressPUTPOSTDELETEGET
    
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

    
"address": "string" Target address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/target-address/

Create operation of resource: target-address

target-address_schema

target-addressbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target addressPUTPOSTDELETEGET
    
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

    
"address": "string" Target address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/target-address/

Delete operation of resource: target-address

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/target/pseudowire/target-address/

Retrieve operation of resource: target-address

operation-id: string
in path

ID of operation-id

200 OK
target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target addressPUTPOSTDELETEGET
    
"vc-id": "integer", Virtual circuit ID
range: "1..4294967295"

    
"address": "string" Target address

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/statistics/

Delete operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/statistics/

Retrieve operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

HISTORY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/history/

Update operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/history/

Create operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/history/

Delete operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/history/

Retrieve operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK
history_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}

ENHANCED-STATS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/

Update operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/

Create operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/

Delete operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/

Retrieve operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK
enhanced-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}

ENHANCED-STAT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/enhanced-stat/{interval}/

Update operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/enhanced-stat/{interval}/

Create operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/enhanced-stat/{interval}/

Delete operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-ping/enhanced-stats/enhanced-stat/{interval}/

Retrieve operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK
enhanced-stat_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}

UDP-ECHO - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/

Update operation of resource: udp-echo

udp-echo_schema

udp-echobody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
UDPEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"verify-data": "null", Check each IPSLA response for corruption

    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"dest-port": "string", Port number on target device

    
"control-disable": "null", Disable control packets

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"source-port": "string", Port number on source device

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP-ECHO - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/

Create operation of resource: udp-echo

udp-echo_schema

udp-echobody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
UDPEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"verify-data": "null", Check each IPSLA response for corruption

    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"dest-port": "string", Port number on target device

    
"control-disable": "null", Disable control packets

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"source-port": "string", Port number on source device

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP-ECHO - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/

Delete operation of resource: udp-echo

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP-ECHO - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/

Retrieve operation of resource: udp-echo

operation-id: string
in path

ID of operation-id

200 OK
udp-echo_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
UDPEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"verify-data": "null", Check each IPSLA response for corruption

    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"dest-port": "string", Port number on target device

    
"control-disable": "null", Disable control packets

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"source-port": "string", Port number on source device

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    }
  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/data-size/

Delete operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/data-size/

Retrieve operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/statistics/

Delete operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/statistics/

Retrieve operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

HISTORY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/history/

Update operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/history/

Create operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/history/

Delete operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/history/

Retrieve operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK
history_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}

ENHANCED-STATS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/

Update operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/

Create operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/

Delete operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/

Retrieve operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK
enhanced-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}

ENHANCED-STAT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/enhanced-stat/{interval}/

Update operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/enhanced-stat/{interval}/

Create operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/enhanced-stat/{interval}/

Delete operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-echo/enhanced-stats/enhanced-stat/{interval}/

Retrieve operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK
enhanced-stat_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}

MPLS-LSP-TRACE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/

Update operation of resource: mpls-lsp-trace

mpls-lsp-trace_schema

mpls-lsp-tracebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
      : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
        : {
Target FEC address with maskPUTPOSTDELETEGET
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering targetPUTPOSTDELETEGET
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type

    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-TRACE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/

Create operation of resource: mpls-lsp-trace

mpls-lsp-trace_schema

mpls-lsp-tracebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
      : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
        : {
Target FEC address with maskPUTPOSTDELETEGET
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering targetPUTPOSTDELETEGET
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type

    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-TRACE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/

Delete operation of resource: mpls-lsp-trace

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-LSP-TRACE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/

Retrieve operation of resource: mpls-lsp-trace

operation-id: string
in path

ID of operation-id

200 OK
mpls-lsp-trace_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
MPLS LSP Trace Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
      : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
        : {
Target FEC address with maskPUTPOSTDELETEGET
          
"mask": "string", IP netmask for target

          
"address": "string" IP address for target

        }
      },
      : {
Traffic engineering targetPUTPOSTDELETEGET
        
"tunnel": "integer" Tunnel interface number
range: "0..65535"

      }
    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"create": "null", Create operation with specified type

    
"tag": "string", Add a tag for this operation

    
"output-interface": "string", Echo request output interface

    
"output-nexthop": "string", Echo request output nexthop

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"ttl": "integer", Time to live value
range: "1..255"
default: "30"
    : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
      
"mode": "string", Enables use of router alert in echo reply\npackets

      
"dscp-bits": "string" DSCP bits in the reply IP header

    },
    
"exp-bits": "integer", EXP bits in MPLS LSP echo reply header
range: "0..7"
default: "0"
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string" Choose type of data to be stored in history\nbuffer

    },
    
"lsp-selector": "string", Attributes used for path selection during LSP\nload balancing

    
"force-explicit-null": "null" Forced option for the MPLS LSP operation

  }
}

TARGET - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/

Update operation of resource: target

target_schema

targetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
    : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
      : {
Target FEC address with maskPUTPOSTDELETEGET
        
"mask": "string", IP netmask for target

        
"address": "string" IP address for target

      }
    },
    : {
Traffic engineering targetPUTPOSTDELETEGET
      
"tunnel": "integer" Tunnel interface number
range: "0..65535"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/

Create operation of resource: target

target_schema

targetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
    : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
      : {
Target FEC address with maskPUTPOSTDELETEGET
        
"mask": "string", IP netmask for target

        
"address": "string" IP address for target

      }
    },
    : {
Traffic engineering targetPUTPOSTDELETEGET
      
"tunnel": "integer" Tunnel interface number
range: "0..65535"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/

Delete operation of resource: target

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/

Retrieve operation of resource: target

operation-id: string
in path

ID of operation-id

200 OK
target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target for the MPLS LSP operationPUTPOSTDELETEGET
    : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
      : {
Target FEC address with maskPUTPOSTDELETEGET
        
"mask": "string", IP netmask for target

        
"address": "string" IP address for target

      }
    },
    : {
Traffic engineering targetPUTPOSTDELETEGET
      
"tunnel": "integer" Tunnel interface number
range: "0..65535"

    }
  }
}

TRAFFIC-ENGINEERING - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/traffic-engineering/

Update operation of resource: traffic-engineering

traffic-engineering_schema

traffic-engineeringbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Traffic engineering targetPUTPOSTDELETEGET
    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/traffic-engineering/

Create operation of resource: traffic-engineering

traffic-engineering_schema

traffic-engineeringbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Traffic engineering targetPUTPOSTDELETEGET
    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/traffic-engineering/

Delete operation of resource: traffic-engineering

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAFFIC-ENGINEERING - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/traffic-engineering/

Retrieve operation of resource: traffic-engineering

operation-id: string
in path

ID of operation-id

200 OK
traffic-engineering_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Traffic engineering targetPUTPOSTDELETEGET
    
"tunnel": "integer" Tunnel interface number
range: "0..65535"

  }
}

IPV4 - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/

Update operation of resource: ipv4

ipv4_schema

ipv4body object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
    : {
Target FEC address with maskPUTPOSTDELETEGET
      
"mask": "string", IP netmask for target

      
"address": "string" IP address for target

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/

Create operation of resource: ipv4

ipv4_schema

ipv4body object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
    : {
Target FEC address with maskPUTPOSTDELETEGET
      
"mask": "string", IP netmask for target

      
"address": "string" IP address for target

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/

Delete operation of resource: ipv4

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/

Retrieve operation of resource: ipv4

operation-id: string
in path

ID of operation-id

200 OK
ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target specified as an IPv4 addressPUTPOSTDELETEGET
    : {
Target FEC address with maskPUTPOSTDELETEGET
      
"mask": "string", IP netmask for target

      
"address": "string" IP address for target

    }
  }
}

FEC-ADDRESS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/fec-address/

Update operation of resource: fec-address

fec-address_schema

fec-addressbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target FEC address with maskPUTPOSTDELETEGET
    
"mask": "string", IP netmask for target

    
"address": "string" IP address for target

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FEC-ADDRESS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/fec-address/

Create operation of resource: fec-address

fec-address_schema

fec-addressbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Target FEC address with maskPUTPOSTDELETEGET
    
"mask": "string", IP netmask for target

    
"address": "string" IP address for target

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FEC-ADDRESS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/fec-address/

Delete operation of resource: fec-address

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FEC-ADDRESS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/target/ipv4/fec-address/

Retrieve operation of resource: fec-address

operation-id: string
in path

ID of operation-id

200 OK
fec-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Target FEC address with maskPUTPOSTDELETEGET
    
"mask": "string", IP netmask for target

    
"address": "string" IP address for target

  }
}

REPLY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/reply/

Update operation of resource: reply

reply_schema

replybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/reply/

Create operation of resource: reply

reply_schema

replybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/reply/

Delete operation of resource: reply

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REPLY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/reply/

Retrieve operation of resource: reply

operation-id: string
in path

ID of operation-id

200 OK
reply_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Echo reply options for the MPLS LSP\noperationPUTPOSTDELETEGET
    
"mode": "string", Enables use of router alert in echo reply\npackets

    
"dscp-bits": "string" DSCP bits in the reply IP header

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/statistics/

Delete operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/statistics/

Retrieve operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

HISTORY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/history/

Update operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/history/

Create operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/history/

Delete operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/mpls-lsp-trace/history/

Retrieve operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK
history_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}

UDP-JITTER - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/

Update operation of resource: udp-jitter

udp-jitter_schema

udp-jitterbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
UDPJitter Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"verify-data": "null", Check each IPSLA response for corruption

    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation
    : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
      
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    },
    
"control-disable": "null", Disable control packets

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"source-port": "string", Port number on source device

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    
"dest-port": "string" Port number on target device

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP-JITTER - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/

Create operation of resource: udp-jitter

udp-jitter_schema

udp-jitterbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
UDPJitter Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"verify-data": "null", Check each IPSLA response for corruption

    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation
    : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
      
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    },
    
"control-disable": "null", Disable control packets

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"source-port": "string", Port number on source device

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    
"dest-port": "string" Port number on target device

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP-JITTER - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/

Delete operation of resource: udp-jitter

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP-JITTER - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/

Retrieve operation of resource: udp-jitter

operation-id: string
in path

ID of operation-id

200 OK
udp-jitter_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
UDPJitter Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an hourPUTPOSTDELETEGET
      
"hours": "integer", Number of hours for which hourly statistics are\nkept
range: "0..25"
units: "hour"
default: "2"

      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"dist-interval": "integer" Specify distribution interval in milliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"verify-data": "null", Check each IPSLA response for corruption

    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation
    : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
      
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    },
    
"control-disable": "null", Disable control packets

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"source-port": "string", Port number on source device

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Table of statistics collection intervalsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

          
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

        }
      ]
    },
    
"dest-port": "string" Port number on target device

  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/data-size/

Delete operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/data-size/

Retrieve operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

PACKET - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/packet/

Update operation of resource: packet

packet_schema

packetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
    
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

    
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/packet/

Create operation of resource: packet

packet_schema

packetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
    
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

    
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/packet/

Delete operation of resource: packet

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/packet/

Retrieve operation of resource: packet

operation-id: string
in path

ID of operation-id

200 OK
packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
    
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

    
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/statistics/

Delete operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/statistics/

Retrieve operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

ENHANCED-STATS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/

Update operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/

Create operation of resource: enhanced-stats

enhanced-stats_schema

enhanced-statsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/

Delete operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STATS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/

Retrieve operation of resource: enhanced-stats

operation-id: string
in path

ID of operation-id

200 OK
enhanced-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of statistics collection intervalsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

        
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

      }
    ]
  }
}

ENHANCED-STAT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/enhanced-stat/{interval}/

Update operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/enhanced-stat/{interval}/

Create operation of resource: enhanced-stat

enhanced-stat_schema

enhanced-statbody object

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/enhanced-stat/{interval}/

Delete operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENHANCED-STAT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/udp-jitter/enhanced-stats/enhanced-stat/{interval}/

Retrieve operation of resource: enhanced-stat

operation-id: string
in path

ID of operation-id

interval: string
in path

ID of interval

200 OK
enhanced-stat_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"buckets": "integer", Buckets of enhanced statistics kept
range: "1..60"
default: "15"

      
"interval": "integer" Interval in seconds
units: "minute"
default: "240"

    }
  ]
}

ICMP-PATH-ECHO - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/

Update operation of resource: icmp-path-echo

icmp-path-echo_schema

icmp-path-echobody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

      
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

      
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

      
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
      
"node8": "string", IPv4 address of the intermediate node

      
"node1": "string", IPv4 address of the intermediate node

      
"node3": "string", IPv4 address of the intermediate node

      
"node2": "string", IPv4 address of the intermediate node

      
"node5": "string", IPv4 address of the intermediate node

      
"node4": "string", IPv4 address of the intermediate node

      
"node7": "string", IPv4 address of the intermediate node

      
"node6": "string" IPv4 address of the intermediate node

    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

      
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-PATH-ECHO - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/

Create operation of resource: icmp-path-echo

icmp-path-echo_schema

icmp-path-echobody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

      
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

      
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

      
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
      
"node8": "string", IPv4 address of the intermediate node

      
"node1": "string", IPv4 address of the intermediate node

      
"node3": "string", IPv4 address of the intermediate node

      
"node2": "string", IPv4 address of the intermediate node

      
"node5": "string", IPv4 address of the intermediate node

      
"node4": "string", IPv4 address of the intermediate node

      
"node7": "string", IPv4 address of the intermediate node

      
"node6": "string" IPv4 address of the intermediate node

    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

      
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-PATH-ECHO - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/

Delete operation of resource: icmp-path-echo

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-PATH-ECHO - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/

Retrieve operation of resource: icmp-path-echo

operation-id: string
in path

ID of operation-id

200 OK
icmp-path-echo_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
ICMPPathEcho Operation typePUTPOSTDELETEGET
    : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
      
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

      
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

      
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

      
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

      
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

    },
    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation

    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

    
"dest-address": "string", Enter IPv4 address of the destination device
    : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
      
"node8": "string", IPv4 address of the intermediate node

      
"node1": "string", IPv4 address of the intermediate node

      
"node3": "string", IPv4 address of the intermediate node

      
"node2": "string", IPv4 address of the intermediate node

      
"node5": "string", IPv4 address of the intermediate node

      
"node4": "string", IPv4 address of the intermediate node

      
"node7": "string", IPv4 address of the intermediate node

      
"node6": "string" IPv4 address of the intermediate node

    },
    : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
      
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

      
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

      
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

      
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

    }
  }
}

HISTORY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/history/

Update operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/history/

Create operation of resource: history

history_schema

historybody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/history/

Delete operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HISTORY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/history/

Retrieve operation of resource: history

operation-id: string
in path

ID of operation-id

200 OK
history_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure the history parameters for this\noperationPUTPOSTDELETEGET
    
"buckets": "integer", Specify number of history buckets
range: "1..60"
default: "15"

    
"lives": "integer", Specify number of lives to be kept
range: "0..2"
default: "0"

    
"history-filter": "string", Choose type of data to be stored in\nhistory buffer

    
"samples": "integer" Specify number of samples to keep
range: "1..30"
default: "16"

  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/data-size/

Delete operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/data-size/

Retrieve operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

STATISTICS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/statistics/

Update operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/statistics/

Create operation of resource: statistics

statistics_schema

statisticsbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/statistics/

Delete operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATISTICS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/statistics/

Retrieve operation of resource: statistics

operation-id: string
in path

ID of operation-id

200 OK
statistics_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Statistics collection aggregated over an\nhourPUTPOSTDELETEGET
    
"dist-count": "integer", Count of distribution intervals maintained
range: "1..20"
default: "1"

    
"paths": "integer", Maximum number of paths for which\nstatistics are kept
range: "1..128"
default: "5"

    
"hops": "integer", Maximum hops per path for which statistics\nare kept
range: "1..30"
default: "16"

    
"hours": "integer", Number of hours for which hourly\nstatistics are kept
range: "0..25"
units: "hour"
default: "2"

    
"dist-interval": "integer" Specify distribution interval in\nmilliseconds
range: "1..100"
units: "millisecond"
default: "20"

  }
}

LSR-PATH - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/lsr-path/

Update operation of resource: lsr-path

lsr-path_schema

lsr-pathbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
    
"node8": "string", IPv4 address of the intermediate node

    
"node1": "string", IPv4 address of the intermediate node

    
"node3": "string", IPv4 address of the intermediate node

    
"node2": "string", IPv4 address of the intermediate node

    
"node5": "string", IPv4 address of the intermediate node

    
"node4": "string", IPv4 address of the intermediate node

    
"node7": "string", IPv4 address of the intermediate node

    
"node6": "string" IPv4 address of the intermediate node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-PATH - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/lsr-path/

Create operation of resource: lsr-path

lsr-path_schema

lsr-pathbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
    
"node8": "string", IPv4 address of the intermediate node

    
"node1": "string", IPv4 address of the intermediate node

    
"node3": "string", IPv4 address of the intermediate node

    
"node2": "string", IPv4 address of the intermediate node

    
"node5": "string", IPv4 address of the intermediate node

    
"node4": "string", IPv4 address of the intermediate node

    
"node7": "string", IPv4 address of the intermediate node

    
"node6": "string" IPv4 address of the intermediate node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-PATH - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/lsr-path/

Delete operation of resource: lsr-path

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-PATH - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-echo/lsr-path/

Retrieve operation of resource: lsr-path

operation-id: string
in path

ID of operation-id

200 OK
lsr-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
    
"node8": "string", IPv4 address of the intermediate node

    
"node1": "string", IPv4 address of the intermediate node

    
"node3": "string", IPv4 address of the intermediate node

    
"node2": "string", IPv4 address of the intermediate node

    
"node5": "string", IPv4 address of the intermediate node

    
"node4": "string", IPv4 address of the intermediate node

    
"node7": "string", IPv4 address of the intermediate node

    
"node6": "string" IPv4 address of the intermediate node

  }
}

ICMP-PATH-JITTER - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/

Update operation of resource: icmp-path-jitter

icmp-path-jitter_schema

icmp-path-jitterbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation
    : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
      
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

      
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

    },
    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
    : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
      
"node8": "string", IPv4 address of the intermediate node

      
"node1": "string", IPv4 address of the intermediate node

      
"node3": "string", IPv4 address of the intermediate node

      
"node2": "string", IPv4 address of the intermediate node

      
"node5": "string", IPv4 address of the intermediate node

      
"node4": "string", IPv4 address of the intermediate node

      
"node7": "string", IPv4 address of the intermediate node

      
"node6": "string" IPv4 address of the intermediate node

    },
    
"dest-address": "string" Enter IPv4 address of the destination device

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-PATH-JITTER - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/

Create operation of resource: icmp-path-jitter

icmp-path-jitter_schema

icmp-path-jitterbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation
    : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
      
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

      
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

    },
    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
    : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
      
"node8": "string", IPv4 address of the intermediate node

      
"node1": "string", IPv4 address of the intermediate node

      
"node3": "string", IPv4 address of the intermediate node

      
"node2": "string", IPv4 address of the intermediate node

      
"node5": "string", IPv4 address of the intermediate node

      
"node4": "string", IPv4 address of the intermediate node

      
"node7": "string", IPv4 address of the intermediate node

      
"node6": "string" IPv4 address of the intermediate node

    },
    
"dest-address": "string" Enter IPv4 address of the destination device

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-PATH-JITTER - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/

Delete operation of resource: icmp-path-jitter

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ICMP-PATH-JITTER - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/

Retrieve operation of resource: icmp-path-jitter

operation-id: string
in path

ID of operation-id

200 OK
icmp-path-jitter_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
ICMPPathJitter Operation typePUTPOSTDELETEGET
    
"source-address": "string", Enter IPv4 address of the source device

    
"tos": "integer", Type of service setting in probe packet
range: "0..255"
default: "0"

    
"create": "null", Create operation with specified type
    : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
      
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

    },
    
"tag": "string", Add a tag for this operation
    : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
      
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

      
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

    },
    
"frequency": "integer", Probe interval in seconds
range: "1..604800"
units: "second"
default: "60"

    
"vrf": "string", Configure IPSLA for a VPN Routing/Forwarding\ninstance)

    
"timeout": "integer", Probe/Control timeout in milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"
    : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
      
"node8": "string", IPv4 address of the intermediate node

      
"node1": "string", IPv4 address of the intermediate node

      
"node3": "string", IPv4 address of the intermediate node

      
"node2": "string", IPv4 address of the intermediate node

      
"node5": "string", IPv4 address of the intermediate node

      
"node4": "string", IPv4 address of the intermediate node

      
"node7": "string", IPv4 address of the intermediate node

      
"node6": "string" IPv4 address of the intermediate node

    },
    
"dest-address": "string" Enter IPv4 address of the destination device

  }
}

DATA-SIZE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/data-size/

Update operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/data-size/

Create operation of resource: data-size

data-size_schema

data-sizebody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/data-size/

Delete operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATA-SIZE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/data-size/

Retrieve operation of resource: data-size

operation-id: string
in path

ID of operation-id

200 OK
data-size_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Protocol data size in payload of probe\npacketsPUTPOSTDELETEGET
    
"request": "integer" Payload size in request probe packet
range: "0..16384"
units: "byte"
default: "100"

  }
}

PACKET - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/packet/

Update operation of resource: packet

packet_schema

packetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
    
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

    
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/packet/

Create operation of resource: packet

packet_schema

packetbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
    
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

    
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/packet/

Delete operation of resource: packet

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PACKET - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/packet/

Retrieve operation of resource: packet

operation-id: string
in path

ID of operation-id

200 OK
packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Probe packet stream configuration\nparametersPUTPOSTDELETEGET
    
"count": "integer", Number of packets to be transmitted during\na probe
range: "1..100"
default: "10"

    
"interval": "integer" Packet interval in milliseconds
units: "minute"
default: "240"

  }
}

LSR-PATH - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/lsr-path/

Update operation of resource: lsr-path

lsr-path_schema

lsr-pathbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
    
"node8": "string", IPv4 address of the intermediate node

    
"node1": "string", IPv4 address of the intermediate node

    
"node3": "string", IPv4 address of the intermediate node

    
"node2": "string", IPv4 address of the intermediate node

    
"node5": "string", IPv4 address of the intermediate node

    
"node4": "string", IPv4 address of the intermediate node

    
"node7": "string", IPv4 address of the intermediate node

    
"node6": "string" IPv4 address of the intermediate node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-PATH - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/lsr-path/

Create operation of resource: lsr-path

lsr-path_schema

lsr-pathbody object

operation-id: string
in path

ID of operation-id

Request Content-Types: application/json
Request Example
{
  : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
    
"node8": "string", IPv4 address of the intermediate node

    
"node1": "string", IPv4 address of the intermediate node

    
"node3": "string", IPv4 address of the intermediate node

    
"node2": "string", IPv4 address of the intermediate node

    
"node5": "string", IPv4 address of the intermediate node

    
"node4": "string", IPv4 address of the intermediate node

    
"node7": "string", IPv4 address of the intermediate node

    
"node6": "string" IPv4 address of the intermediate node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-PATH - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/lsr-path/

Delete operation of resource: lsr-path

operation-id: string
in path

ID of operation-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LSR-PATH - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/operation/definitions/definition/{operation-id}/operation-type/icmp-path-jitter/lsr-path/

Retrieve operation of resource: lsr-path

operation-id: string
in path

ID of operation-id

200 OK
lsr-path_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Loose source routing path (up to 8 intermediate\nnodes)PUTPOSTDELETEGET
    
"node8": "string", IPv4 address of the intermediate node

    
"node1": "string", IPv4 address of the intermediate node

    
"node3": "string", IPv4 address of the intermediate node

    
"node2": "string", IPv4 address of the intermediate node

    
"node5": "string", IPv4 address of the intermediate node

    
"node4": "string", IPv4 address of the intermediate node

    
"node7": "string", IPv4 address of the intermediate node

    
"node6": "string" IPv4 address of the intermediate node

  }
}

RESPONDER - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/

Update operation of resource: responder

responder_schema

responderbody object

Request Content-Types: application/json
Request Example
{
  : {
Responder configurationPUTPOSTDELETEGET
    
"enable": "null", Starts the responder process
    : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
      : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
        : {
Configure IP addressPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"local-address": "string", IP address of the Responder
              : {
Configure portPUTPOSTDELETEGET
                : [
Port number to be enabledPUTPOSTDELETEGET
                  {
                    
"port": "string" Port number to be enabled

                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RESPONDER - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/

Create operation of resource: responder

responder_schema

responderbody object

Request Content-Types: application/json
Request Example
{
  : {
Responder configurationPUTPOSTDELETEGET
    
"enable": "null", Starts the responder process
    : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
      : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
        : {
Configure IP addressPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"local-address": "string", IP address of the Responder
              : {
Configure portPUTPOSTDELETEGET
                : [
Port number to be enabledPUTPOSTDELETEGET
                  {
                    
"port": "string" Port number to be enabled

                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RESPONDER - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/

Delete operation of resource: responder

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RESPONDER - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/

Retrieve operation of resource: responder

200 OK
responder_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Responder configurationPUTPOSTDELETEGET
    
"enable": "null", Starts the responder process
    : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
      : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
        : {
Configure IP addressPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"local-address": "string", IP address of the Responder
              : {
Configure portPUTPOSTDELETEGET
                : [
Port number to be enabledPUTPOSTDELETEGET
                  {
                    
"port": "string" Port number to be enabled

                  }
                ]
              }
            }
          ]
        }
      }
    }
  }
}

TYPE - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/

Update operation of resource: type

type_schema

typebody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
    : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
      : {
Configure IP addressPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"local-address": "string", IP address of the Responder
            : {
Configure portPUTPOSTDELETEGET
              : [
Port number to be enabledPUTPOSTDELETEGET
                {
                  
"port": "string" Port number to be enabled

                }
              ]
            }
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TYPE - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/

Create operation of resource: type

type_schema

typebody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
    : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
      : {
Configure IP addressPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"local-address": "string", IP address of the Responder
            : {
Configure portPUTPOSTDELETEGET
              : [
Port number to be enabledPUTPOSTDELETEGET
                {
                  
"port": "string" Port number to be enabled

                }
              ]
            }
          }
        ]
      }
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TYPE - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/

Delete operation of resource: type

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TYPE - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/

Retrieve operation of resource: type

200 OK
type_schema

Successful operation

type
type_schema
400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IPSLA Responder port typePUTPOSTDELETEGET
    : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
      : {
Configure IP addressPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"local-address": "string", IP address of the Responder
            : {
Configure portPUTPOSTDELETEGET
              : [
Port number to be enabledPUTPOSTDELETEGET
                {
                  
"port": "string" Port number to be enabled

                }
              ]
            }
          }
        ]
      }
    }
  }
}

UDP - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/

Update operation of resource: udp

udp_schema

udpbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
    : {
Configure IP addressPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"local-address": "string", IP address of the Responder
          : {
Configure portPUTPOSTDELETEGET
            : [
Port number to be enabledPUTPOSTDELETEGET
              {
                
"port": "string" Port number to be enabled

              }
            ]
          }
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/

Create operation of resource: udp

udp_schema

udpbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
    : {
Configure IP addressPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"local-address": "string", IP address of the Responder
          : {
Configure portPUTPOSTDELETEGET
            : [
Port number to be enabledPUTPOSTDELETEGET
              {
                
"port": "string" Port number to be enabled

              }
            ]
          }
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/

Delete operation of resource: udp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

UDP - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/

Retrieve operation of resource: udp

200 OK
udp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IPSLA Responder UDP address and portPUTPOSTDELETEGET
    : {
Configure IP addressPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"local-address": "string", IP address of the Responder
          : {
Configure portPUTPOSTDELETEGET
            : [
Port number to be enabledPUTPOSTDELETEGET
              {
                
"port": "string" Port number to be enabled

              }
            ]
          }
        }
      ]
    }
  }
}

ADDRESSES - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/

Update operation of resource: addresses

addresses_schema

addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IP addressPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"local-address": "string", IP address of the Responder
        : {
Configure portPUTPOSTDELETEGET
          : [
Port number to be enabledPUTPOSTDELETEGET
            {
              
"port": "string" Port number to be enabled

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESSES - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/

Create operation of resource: addresses

addresses_schema

addressesbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure IP addressPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"local-address": "string", IP address of the Responder
        : {
Configure portPUTPOSTDELETEGET
          : [
Port number to be enabledPUTPOSTDELETEGET
            {
              
"port": "string" Port number to be enabled

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESSES - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/

Delete operation of resource: addresses

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESSES - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/

Retrieve operation of resource: addresses

200 OK
addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure IP addressPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"local-address": "string", IP address of the Responder
        : {
Configure portPUTPOSTDELETEGET
          : [
Port number to be enabledPUTPOSTDELETEGET
            {
              
"port": "string" Port number to be enabled

            }
          ]
        }
      }
    ]
  }
}

ADDRESS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/

Update operation of resource: address

address_schema

addressbody object

local-address: string
in path

ID of local-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"local-address": "string", IP address of the Responder
      : {
Configure portPUTPOSTDELETEGET
        : [
Port number to be enabledPUTPOSTDELETEGET
          {
            
"port": "string" Port number to be enabled

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/

Create operation of resource: address

address_schema

addressbody object

local-address: string
in path

ID of local-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"local-address": "string", IP address of the Responder
      : {
Configure portPUTPOSTDELETEGET
        : [
Port number to be enabledPUTPOSTDELETEGET
          {
            
"port": "string" Port number to be enabled

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/

Delete operation of resource: address

local-address: string
in path

ID of local-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADDRESS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/

Retrieve operation of resource: address

local-address: string
in path

ID of local-address

200 OK
address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"local-address": "string", IP address of the Responder
      : {
Configure portPUTPOSTDELETEGET
        : [
Port number to be enabledPUTPOSTDELETEGET
          {
            
"port": "string" Port number to be enabled

          }
        ]
      }
    }
  ]
}

PORTS - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/

Update operation of resource: ports

ports_schema

portsbody object

local-address: string
in path

ID of local-address

Request Content-Types: application/json
Request Example
{
  : {
Configure portPUTPOSTDELETEGET
    : [
Port number to be enabledPUTPOSTDELETEGET
      {
        
"port": "string" Port number to be enabled

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PORTS - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/

Create operation of resource: ports

ports_schema

portsbody object

local-address: string
in path

ID of local-address

Request Content-Types: application/json
Request Example
{
  : {
Configure portPUTPOSTDELETEGET
    : [
Port number to be enabledPUTPOSTDELETEGET
      {
        
"port": "string" Port number to be enabled

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PORTS - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/

Delete operation of resource: ports

local-address: string
in path

ID of local-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PORTS - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/

Retrieve operation of resource: ports

local-address: string
in path

ID of local-address

200 OK
ports_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure portPUTPOSTDELETEGET
    : [
Port number to be enabledPUTPOSTDELETEGET
      {
        
"port": "string" Port number to be enabled

      }
    ]
  }
}

PORT - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/port/{port}/

Update operation of resource: port

port_schema

portbody object

local-address: string
in path

ID of local-address

port: string
in path

ID of port

Request Content-Types: application/json
Request Example
{
  : [
Port number to be enabledPUTPOSTDELETEGET
    {
      
"port": "string" Port number to be enabled

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PORT - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/port/{port}/

Create operation of resource: port

port_schema

portbody object

local-address: string
in path

ID of local-address

port: string
in path

ID of port

Request Content-Types: application/json
Request Example
{
  : [
Port number to be enabledPUTPOSTDELETEGET
    {
      
"port": "string" Port number to be enabled

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PORT - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/port/{port}/

Delete operation of resource: port

local-address: string
in path

ID of local-address

port: string
in path

ID of port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PORT - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/responder/type/udp/addresses/address/{local-address}/ports/port/{port}/

Retrieve operation of resource: port

local-address: string
in path

ID of local-address

port: string
in path

ID of port

200 OK
port_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
Port number to be enabledPUTPOSTDELETEGET
    {
      
"port": "string" Port number to be enabled

    }
  ]
}

MPLS-DISCOVERY - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/

Update operation of resource: mpls-discovery

mpls-discovery_schema

mpls-discoverybody object

Request Content-Types: application/json
Request Example
{
  : {
Provider Edge(PE) discovery configurationPUTPOSTDELETEGET
    : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
      
"interval": "integer" Specify a discovery refresh interval
units: "minute"
default: "240"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-DISCOVERY - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/

Create operation of resource: mpls-discovery

mpls-discovery_schema

mpls-discoverybody object

Request Content-Types: application/json
Request Example
{
  : {
Provider Edge(PE) discovery configurationPUTPOSTDELETEGET
    : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
      
"interval": "integer" Specify a discovery refresh interval
units: "minute"
default: "240"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-DISCOVERY - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/

Delete operation of resource: mpls-discovery

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MPLS-DISCOVERY - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/

Retrieve operation of resource: mpls-discovery

200 OK
mpls-discovery_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Provider Edge(PE) discovery configurationPUTPOSTDELETEGET
    : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
      
"interval": "integer" Specify a discovery refresh interval
units: "minute"
default: "240"

    }
  }
}

VPN - Update

PUT Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/vpn/

Update operation of resource: vpn

vpn_schema

vpnbody object

Request Content-Types: application/json
Request Example
{
  : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
    
"interval": "integer" Specify a discovery refresh interval
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPN - Create

POST Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/vpn/

Create operation of resource: vpn

vpn_schema

vpnbody object

Request Content-Types: application/json
Request Example
{
  : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
    
"interval": "integer" Specify a discovery refresh interval
units: "minute"
default: "240"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPN - Delete

DELETE Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/vpn/

Delete operation of resource: vpn

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VPN - Retrieve

GET Cisco-IOS-XR-man-ipsla-cfg:ipsla/mpls-discovery/vpn/

Retrieve operation of resource: vpn

200 OK
vpn_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Layer 3 VPN PE discovery configurationPUTPOSTDELETEGET
    
"interval": "integer" Specify a discovery refresh interval
units: "minute"
default: "240"

  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitie mapsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

a1_encrypted-community-maps_schema

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitie mapsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

200 OK
a1_encrypted-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold clear/encrypted\ncommunitie mapsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

a1_encrypted-community-map_schema

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to configure a SNMPv2 MIB viewPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"view-name": "string", Name of the view

        
"view-inclusion": "string", MIB view to be included or excluded

        
"family": "string" MIB view family name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

a1_views_schema

viewsbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to configure a SNMPv2 MIB viewPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"view-name": "string", Name of the view

        
"view-inclusion": "string", MIB view to be included or excluded

        
"family": "string" MIB view family name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

200 OK
a1_views_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Class to configure a SNMPv2 MIB viewPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"view-name": "string", Name of the view

        
"view-inclusion": "string", MIB view to be included or excluded

        
"family": "string" MIB view family name

      }
    ]
  }
}

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"view-name": "string", Name of the view

      
"view-inclusion": "string", MIB view to be included or excluded

      
"family": "string" MIB view family name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

a1_view_schema

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"view-name": "string", Name of the view

      
"view-inclusion": "string", MIB view to be included or excluded

      
"family": "string" MIB view family name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK
a1_view_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"view-name": "string", Name of the view

      
"view-inclusion": "string", MIB view to be included or excluded

      
"family": "string" MIB view family name

    }
  ]
}

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP loggingPUTPOSTDELETEGET
    : {
SNMP logging thresholdPUTPOSTDELETEGET
      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

      
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

a1_logging_schema

loggingbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP loggingPUTPOSTDELETEGET
    : {
SNMP logging thresholdPUTPOSTDELETEGET
      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

      
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

200 OK
a1_logging_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP loggingPUTPOSTDELETEGET
    : {
SNMP logging thresholdPUTPOSTDELETEGET
      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

      
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

    }
  }
}

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP logging thresholdPUTPOSTDELETEGET
    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

    
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

a1_threshold_schema

thresholdbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP logging thresholdPUTPOSTDELETEGET
    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

    
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

200 OK
a1_threshold_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP logging thresholdPUTPOSTDELETEGET
    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"

    
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"

  }
}

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class for SNMP administrationPUTPOSTDELETEGET
    : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    },
    : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

a1_administration_schema

administrationbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class for SNMP administrationPUTPOSTDELETEGET
    : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    },
    : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

200 OK
a1_administration_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for SNMP administrationPUTPOSTDELETEGET
    : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    },
    : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"priviledge": "string", Read/Write Access

          
"view-name": "string", MIB view to which the community has access

          
"v6acl-type": "string", Access-list type

          
"v6-access-list": "string", Ipv6 Access-list name

          
"community-name": "string", SNMP community string

          
"owner": "string", Logical Router or System owner access

          
"v4acl-type": "string", Access-list type

          
"v4-access-list": "string" Ipv4 Access-list name

        }
      ]
    }
  }
}

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

a1_default-communities_schema

default-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

200 OK
a1_default-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold unencrpted communitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

a1_default-community_schema

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK
a1_default-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

a1_encrypted-communities_schema

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

200 OK
a1_encrypted-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold clear/encrypted\ncommunitiesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"priviledge": "string", Read/Write Access

        
"view-name": "string", MIB view to which the community has access

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"community-name": "string", SNMP community string

        
"owner": "string", Logical Router or System owner access

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string" Ipv4 Access-list name

      }
    ]
  }
}

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

a1_encrypted-community_schema

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"priviledge": "string", Read/Write Access

    
"view-name": "string", MIB view to which the community has access

    
"v6acl-type": "string", Access-list type

    
"v6-access-list": "string", Ipv6 Access-list name

    
"community-name": "string", SNMP community string

    
"owner": "string", Logical Router or System owner access

    
"v4acl-type": "string", Access-list type

    
"v4-access-list": "string" Ipv4 Access-list name

  }
}

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : {
The heirarchy point for SNMP Agent\nconfigurationsPUTPOSTDELETEGET
    : {
SNMPv3 engineIDPUTPOSTDELETEGET
      : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"remote-engine-id": "string", engine ID octet string

            
"remote-address": "string", IP address of remote SNMP entity

            
"port": "string" UDP port number

          }
        ]
      },
      
"local": "string" engineID of the local agent

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

a1_agent_schema

agentbody object

Request Content-Types: application/json
Request Example
{
  : {
The heirarchy point for SNMP Agent\nconfigurationsPUTPOSTDELETEGET
    : {
SNMPv3 engineIDPUTPOSTDELETEGET
      : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"remote-engine-id": "string", engine ID octet string

            
"remote-address": "string", IP address of remote SNMP entity

            
"port": "string" UDP port number

          }
        ]
      },
      
"local": "string" engineID of the local agent

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

200 OK
a1_agent_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
The heirarchy point for SNMP Agent\nconfigurationsPUTPOSTDELETEGET
    : {
SNMPv3 engineIDPUTPOSTDELETEGET
      : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"remote-engine-id": "string", engine ID octet string

            
"remote-address": "string", IP address of remote SNMP entity

            
"port": "string" UDP port number

          }
        ]
      },
      
"local": "string" engineID of the local agent

    }
  }
}

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 engineIDPUTPOSTDELETEGET
    : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"remote-engine-id": "string", engine ID octet string

          
"remote-address": "string", IP address of remote SNMP entity

          
"port": "string" UDP port number

        }
      ]
    },
    
"local": "string" engineID of the local agent

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

a1_engine-id_schema

engine-idbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 engineIDPUTPOSTDELETEGET
    : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"remote-engine-id": "string", engine ID octet string

          
"remote-address": "string", IP address of remote SNMP entity

          
"port": "string" UDP port number

        }
      ]
    },
    
"local": "string" engineID of the local agent

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

200 OK
a1_engine-id_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMPv3 engineIDPUTPOSTDELETEGET
    : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"remote-engine-id": "string", engine ID octet string

          
"remote-address": "string", IP address of remote SNMP entity

          
"port": "string" UDP port number

        }
      ]
    },
    
"local": "string" engineID of the local agent

  }
}

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"remote-engine-id": "string", engine ID octet string

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string" UDP port number

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

a1_remotes_schema

remotesbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"remote-engine-id": "string", engine ID octet string

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string" UDP port number

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

200 OK
a1_remotes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMPv3 remote SNMP EntityPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"remote-engine-id": "string", engine ID octet string

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string" UDP port number

      }
    ]
  }
}

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"remote-engine-id": "string", engine ID octet string

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string" UDP port number

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

a1_remote_schema

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"remote-engine-id": "string", engine ID octet string

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string" UDP port number

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK
a1_remote_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"remote-engine-id": "string", engine ID octet string

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string" UDP port number

    }
  ]
}

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to hold trap configurationsPUTPOSTDELETEGET
    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"

    
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"

    
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
default: "5000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

a1_trap_schema

trapbody object

Request Content-Types: application/json
Request Example
{
  : {
Class to hold trap configurationsPUTPOSTDELETEGET
    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"

    
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"

    
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
default: "5000"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

200 OK
a1_trap_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Class to hold trap configurationsPUTPOSTDELETEGET
    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"

    
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"

    
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
default: "5000"

  }
}

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP packet drop configPUTPOSTDELETEGET
    
"unknown-user": "null" Enable drop unknown user name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

a1_drop-packet_schema

drop-packetbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP packet drop configPUTPOSTDELETEGET
    
"unknown-user": "null" Enable drop unknown user name

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

200 OK
a1_drop-packet_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP packet drop configPUTPOSTDELETEGET
    
"unknown-user": "null" Enable drop unknown user name

  }
}

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

a1_ipv6_schema

ipv6body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

200 OK
a1_ipv6_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

a1_ipv4_schema

ipv4body object

Request Content-Types: application/json
Request Example
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

200 OK
a1_ipv4_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP TOS bit for outgoing packetsPUTPOSTDELETEGET
    : {
Type of TOSPUTPOSTDELETEGET
      
"type": "string", SNMP TOS type DSCP or Precedence

      
"dscp": "string", SNMP DSCP value

      
"precedence": "string" SNMP Precedence value

    }
  }
}

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

a1_tos_schema

tosbody object

Request Content-Types: application/json
Request Example
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK
a1_tos_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Type of TOSPUTPOSTDELETEGET
    
"type": "string", SNMP TOS type DSCP or Precedence

    
"dscp": "string", SNMP DSCP value

    
"precedence": "string" SNMP Precedence value

  }
}

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  : {
container to hold system informationPUTPOSTDELETEGET
    
"chassis-id": "string", String to uniquely identify this chassis

    
"contact": "string", identification of the contact person for this\nmanaged node

    
"location": "string" The physical location of this node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

a1_system_schema

systembody object

Request Content-Types: application/json
Request Example
{
  : {
container to hold system informationPUTPOSTDELETEGET
    
"chassis-id": "string", String to uniquely identify this chassis

    
"contact": "string", identification of the contact person for this\nmanaged node

    
"location": "string" The physical location of this node

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

200 OK
a1_system_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
container to hold system informationPUTPOSTDELETEGET
    
"chassis-id": "string", String to uniquely identify this chassis

    
"contact": "string", identification of the contact person for this\nmanaged node

    
"location": "string" The physical location of this node

  }
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurations
      : [
No description
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target list
      : [
No description
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

a1_target_schema

targetbody object

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurations
      : [
No description
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target list
      : [
No description
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurations
      : [
No description
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target list
      : [
No description
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of targetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
SNMP Target address configurationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"ip-address": "string" IPv4/Ipv6 address

            }
          ]
        },
        
"target-list-name": "string", Name of the target list
        : {
List of VRF Name for a target listPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"name": "string" VRF Name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

a1_targets_schema

targetsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of targetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
SNMP Target address configurationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"ip-address": "string" IPv4/Ipv6 address

            }
          ]
        },
        
"target-list-name": "string", Name of the target list
        : {
List of VRF Name for a target listPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"name": "string" VRF Name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

200 OK
a1_targets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of targetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
SNMP Target address configurationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"ip-address": "string" IPv4/Ipv6 address

            }
          ]
        },
        
"target-list-name": "string", Name of the target list
        : {
List of VRF Name for a target listPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"name": "string" VRF Name

            }
          ]
        }
      }
    ]
  }
}

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurationsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target listPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

a1_target_schema

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurationsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target listPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    : {
SNMP Target address configurationsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"ip-address": "string" IPv4/Ipv6 address

        }
      ]
    },
    
"target-list-name": "string", Name of the target list
    : {
List of VRF Name for a target listPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"name": "string" VRF Name

        }
      ]
    }
  }
}

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
List of VRF Name for a target listPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string" VRF Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

a1_vrf-names_schema

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
List of VRF Name for a target listPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string" VRF Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK
a1_vrf-names_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of VRF Name for a target listPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string" VRF Name

      }
    ]
  }
}

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string" VRF Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

a1_vrf-name_schema

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string" VRF Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK
a1_vrf-name_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string" VRF Name

    }
  ]
}

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
SNMP Target address configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ip-address": "string" IPv4/Ipv6 address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

a1_target-addresses_schema

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{
  : {
SNMP Target address configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ip-address": "string" IPv4/Ipv6 address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK
a1_target-addresses_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP Target address configurationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"ip-address": "string" IPv4/Ipv6 address

      }
    ]
  }
}

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"ip-address": "string" IPv4/Ipv6 address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

a1_target-address_schema

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"ip-address": "string" IPv4/Ipv6 address

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK
a1_target-address_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"ip-address": "string" IPv4/Ipv6 address

  }
}

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable SNMP notificationsPUTPOSTDELETEGET
    
"ipsla": "boolean", Enable SNMP RTTMON-MIB IPSLA traps
    : {
SNMP notification configurationPUTPOSTDELETEGET
      
"authentication": "null", Enable authentication notification

      
"enable": "null", Enable SNMP notifications

      
"warm-start": "null", Enable warm start notification

      
"cold-start": "null" Enable cold start notification

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

a1_notification_schema

notificationbody object

Request Content-Types: application/json
Request Example
{
  : {
Enable SNMP notificationsPUTPOSTDELETEGET
    
"ipsla": "boolean", Enable SNMP RTTMON-MIB IPSLA traps
    : {
SNMP notification configurationPUTPOSTDELETEGET
      
"authentication": "null", Enable authentication notification

      
"enable": "null", Enable SNMP notifications

      
"warm-start": "null", Enable warm start notification

      
"cold-start": "null" Enable cold start notification

    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

200 OK
a1_notification_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Enable SNMP notificationsPUTPOSTDELETEGET
    
"ipsla": "boolean", Enable SNMP RTTMON-MIB IPSLA traps
    : {
SNMP notification configurationPUTPOSTDELETEGET
      
"authentication": "null", Enable authentication notification

      
"enable": "null", Enable SNMP notifications

      
"warm-start": "null", Enable warm start notification

      
"cold-start": "null" Enable cold start notification

    }
  }
}

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

a1_snmp_schema

snmpbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

200 OK
a1_snmp_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP notification configurationPUTPOSTDELETEGET
    
"authentication": "null", Enable authentication notification

    
"enable": "null", Enable SNMP notifications

    
"warm-start": "null", Enable warm start notification

    
"cold-start": "null" Enable cold start notification

  }
}

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure properties of the trap correlatorPUTPOSTDELETEGET
    : {
Table of configured rulesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Table of configured non-rootcausePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"name": "string" Ruleset name

        }
      ]
    },
    : {
Table of configured rulesetsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          
"name": "string", Ruleset name
          : {
Table of configured rulenamesPUTPOSTDELETEGET
            : [
Rule namePUTPOSTDELETEGET
              {
                
"rulename": "string" Rule name

              }
            ]
          }
        }
      ]
    },
    
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

a1_correlator_schema

correlatorbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure properties of the trap correlatorPUTPOSTDELETEGET
    : {
Table of configured rulesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Table of configured non-rootcausePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"name": "string" Ruleset name

        }
      ]
    },
    : {
Table of configured rulesetsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          
"name": "string", Ruleset name
          : {
Table of configured rulenamesPUTPOSTDELETEGET
            : [
Rule namePUTPOSTDELETEGET
              {
                
"rulename": "string" Rule name

              }
            ]
          }
        }
      ]
    },
    
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

200 OK
a1_correlator_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure properties of the trap correlatorPUTPOSTDELETEGET
    : {
Table of configured rulesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Table of configured non-rootcausePUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                : {
Varbinds to matchPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
                      : {
VarBind match conditionsPUTPOSTDELETEGET
                        
"index": "string", Regular Expression to match index

                        
"value": "string" Regular Expression to match value

                      }
                    }
                  ]
                },
                
"oid": "string", OID of rootcause trap (dotted decimal)

                
"created": "null" Create rootcause

              }
            ]
          },
          
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

          
"name": "string" Ruleset name

        }
      ]
    },
    : {
Table of configured rulesetsPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
            
"all": "null", Apply to all of the device
            : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", Port (specify 162 for default)

                  
"ip-address": "string" IP address

                }
              ]
            }
          },
          
"name": "string", Ruleset name
          : {
Table of configured rulenamesPUTPOSTDELETEGET
            : [
Rule namePUTPOSTDELETEGET
              {
                
"rulename": "string" Rule name

              }
            ]
          }
        }
      ]
    },
    
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"

  }
}

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Table of configured non-rootcausePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

        
"name": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

a1_rules_schema

rulesbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Table of configured non-rootcausePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

        
"name": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

200 OK
a1_rules_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rulesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Table of configured non-rootcausePUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Varbinds to matchPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
                    : {
VarBind match conditionsPUTPOSTDELETEGET
                      
"index": "string", Regular Expression to match index

                      
"value": "string" Regular Expression to match value

                    }
                  }
                ]
              },
              
"oid": "string", OID of rootcause trap (dotted decimal)

              
"created": "null" Create rootcause

            }
          ]
        },
        
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

        
"name": "string" Rule name

      }
    ]
  }
}

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Table of configured non-rootcausePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"name": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

a1_rule_schema

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Table of configured non-rootcausePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"name": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

200 OK
a1_rule_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Table of configured non-rootcausePUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Varbinds to matchPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
                  : {
VarBind match conditionsPUTPOSTDELETEGET
                    
"index": "string", Regular Expression to match index

                    
"value": "string" Regular Expression to match value

                  }
                }
              ]
            },
            
"oid": "string", OID of rootcause trap (dotted decimal)

            
"created": "null" Create rootcause

          }
        ]
      },
      
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
default: "5000"

      
"name": "string" Rule name

    }
  ]
}

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of rootcause trap (dotted decimal)

        
"created": "null" Create rootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

a1_root-causes_schema

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of rootcause trap (dotted decimal)

        
"created": "null" Create rootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

200 OK
a1_root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rootcause (only one entry\nallowed)PUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of rootcause trap (dotted decimal)

        
"created": "null" Create rootcause

      }
    ]
  }
}

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of rootcause trap (dotted decimal)

      
"created": "null" Create rootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

a1_root-cause_schema

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of rootcause trap (dotted decimal)

      
"created": "null" Create rootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of rootcause trap (dotted decimal)

      
"created": "null" Create rootcause

    }
  ]
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured non-rootcausePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of nonrootcause trap (dotted decimal)

        
"created": "null" Create nonrootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

a1_non-root-causes_schema

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured non-rootcausePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of nonrootcause trap (dotted decimal)

        
"created": "null" Create nonrootcause

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

200 OK
a1_non-root-causes_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured non-rootcausePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Varbinds to matchPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
              : {
VarBind match conditionsPUTPOSTDELETEGET
                
"index": "string", Regular Expression to match index

                
"value": "string" Regular Expression to match value

              }
            }
          ]
        },
        
"oid": "string", OID of nonrootcause trap (dotted decimal)

        
"created": "null" Create nonrootcause

      }
    ]
  }
}

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of nonrootcause trap (dotted decimal)

      
"created": "null" Create nonrootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

a1_non-root-cause_schema

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of nonrootcause trap (dotted decimal)

      
"created": "null" Create nonrootcause

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_non-root-cause_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Varbinds to matchPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
            : {
VarBind match conditionsPUTPOSTDELETEGET
              
"index": "string", Regular Expression to match index

              
"value": "string" Regular Expression to match value

            }
          }
        ]
      },
      
"oid": "string", OID of nonrootcause trap (dotted decimal)

      
"created": "null" Create nonrootcause

    }
  ]
}

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

a1_var-binds_schema

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK
a1_var-binds_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Varbinds to matchPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string", OID of varbind (dotted decimal)
        : {
VarBind match conditionsPUTPOSTDELETEGET
          
"index": "string", Regular Expression to match index

          
"value": "string" Regular Expression to match value

        }
      }
    ]
  }
}

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

a1_var-bind_schema

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_var-bind_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string", OID of varbind (dotted decimal)
      : {
VarBind match conditionsPUTPOSTDELETEGET
        
"index": "string", Regular Expression to match index

        
"value": "string" Regular Expression to match value

      }
    }
  ]
}

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

a1_match_schema

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK
a1_match_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
VarBind match conditionsPUTPOSTDELETEGET
    
"index": "string", Regular Expression to match index

    
"value": "string" Regular Expression to match value

  }
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        
"name": "string", Ruleset name
        : {
Table of configured rulenamesPUTPOSTDELETEGET
          : [
Rule namePUTPOSTDELETEGET
            {
              
"rulename": "string" Rule name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

a1_rule-sets_schema

rule-setsbody object

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulesetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        
"name": "string", Ruleset name
        : {
Table of configured rulenamesPUTPOSTDELETEGET
          : [
Rule namePUTPOSTDELETEGET
            {
              
"rulename": "string" Rule name

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

200 OK
a1_rule-sets_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rulesetsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
          
"all": "null", Apply to all of the device
          : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", Port (specify 162 for default)

                
"ip-address": "string" IP address

              }
            ]
          }
        },
        
"name": "string", Ruleset name
        : {
Table of configured rulenamesPUTPOSTDELETEGET
          : [
Rule namePUTPOSTDELETEGET
            {
              
"rulename": "string" Rule name

            }
          ]
        }
      }
    ]
  }
}

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      
"name": "string", Ruleset name
      : {
Table of configured rulenamesPUTPOSTDELETEGET
        : [
Rule namePUTPOSTDELETEGET
          {
            
"rulename": "string" Rule name

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

a1_rule-set_schema

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      
"name": "string", Ruleset name
      : {
Table of configured rulenamesPUTPOSTDELETEGET
        : [
Rule namePUTPOSTDELETEGET
          {
            
"rulename": "string" Rule name

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

200 OK
a1_rule-set_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
        
"all": "null", Apply to all of the device
        : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", Port (specify 162 for default)

              
"ip-address": "string" IP address

            }
          ]
        }
      },
      
"name": "string", Ruleset name
      : {
Table of configured rulenamesPUTPOSTDELETEGET
        : [
Rule namePUTPOSTDELETEGET
          {
            
"rulename": "string" Rule name

          }
        ]
      }
    }
  ]
}

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulenamesPUTPOSTDELETEGET
    : [
Rule namePUTPOSTDELETEGET
      {
        
"rulename": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

a1_rulenames_schema

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured rulenamesPUTPOSTDELETEGET
    : [
Rule namePUTPOSTDELETEGET
      {
        
"rulename": "string" Rule name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

200 OK
a1_rulenames_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured rulenamesPUTPOSTDELETEGET
    : [
Rule namePUTPOSTDELETEGET
      {
        
"rulename": "string" Rule name

      }
    ]
  }
}

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  : [
Rule namePUTPOSTDELETEGET
    {
      
"rulename": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

a1_rulename_schema

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{
  : [
Rule namePUTPOSTDELETEGET
    {
      
"rulename": "string" Rule name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK
a1_rulename_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
Rule namePUTPOSTDELETEGET
    {
      
"rulename": "string" Rule name

    }
  ]
}

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

a1_applied-to_schema

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

200 OK
a1_applied-to_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Applied to the Rule or RulesetPUTPOSTDELETEGET
    
"all": "null", Apply to all of the device
    : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", Port (specify 162 for default)

          
"ip-address": "string" IP address

        }
      ]
    }
  }
}

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

a1_hosts_schema

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

200 OK
a1_hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Table of configured hosts to apply rules toPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", Port (specify 162 for default)

        
"ip-address": "string" IP address

      }
    ]
  }
}

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

a1_host_schema

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK
a1_host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"port": "string", Port (specify 162 for default)

      
"ip-address": "string" IP address

    }
  ]
}

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP bulk stats configuration commandsPUTPOSTDELETEGET
    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
    : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
          : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"schema-name": "string" The name of the schema

              }
            ]
          },
          
"format": "string", Format of the bulk data file

          
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

          
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

          
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

          
"enable": "null", Start Data Collection for this Configuration

          
"transfer-name": "string", Name of bulk transfer

          
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

          
"type": "null", Configure schema name

          
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

        }
      ]
    },
    : {
Configure an object ListPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"object-list-name": "string", Name of the object List
          : {
Configure an object ListPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"oid": "string" Object name or OID 

              }
            ]
          },
          
"type": "null" Configure schema name

        }
      ]
    },
    : {
Configure schema definitionPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"schema-name": "string", The name of the schema
          : {
Instance of the schemaPUTPOSTDELETEGET
            
"end": "string", End Instance OID for repetition

            
"sub-interface": "boolean", Include all the subinterface

            
"start": "string", Start Instance OID for repetition

            
"max": "integer", Max value of Instance repetition

            
"instance": "string", Instance of the schema

            
"type": "string" Configure schema name

          },
          
"type": "null", Configure schema name

          
"schema-object-list": "string", Name of an object List

          
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

a1_bulk-stats_schema

bulk-statsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP bulk stats configuration commandsPUTPOSTDELETEGET
    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
    : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
          : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"schema-name": "string" The name of the schema

              }
            ]
          },
          
"format": "string", Format of the bulk data file

          
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

          
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

          
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

          
"enable": "null", Start Data Collection for this Configuration

          
"transfer-name": "string", Name of bulk transfer

          
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

          
"type": "null", Configure schema name

          
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

        }
      ]
    },
    : {
Configure an object ListPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"object-list-name": "string", Name of the object List
          : {
Configure an object ListPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"oid": "string" Object name or OID 

              }
            ]
          },
          
"type": "null" Configure schema name

        }
      ]
    },
    : {
Configure schema definitionPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"schema-name": "string", The name of the schema
          : {
Instance of the schemaPUTPOSTDELETEGET
            
"end": "string", End Instance OID for repetition

            
"sub-interface": "boolean", Include all the subinterface

            
"start": "string", Start Instance OID for repetition

            
"max": "integer", Max value of Instance repetition

            
"instance": "string", Instance of the schema

            
"type": "string" Configure schema name

          },
          
"type": "null", Configure schema name

          
"schema-object-list": "string", Name of an object List

          
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

200 OK
a1_bulk-stats_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP bulk stats configuration commandsPUTPOSTDELETEGET
    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
    : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
          : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"schema-name": "string" The name of the schema

              }
            ]
          },
          
"format": "string", Format of the bulk data file

          
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

          
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

          
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

          
"enable": "null", Start Data Collection for this Configuration

          
"transfer-name": "string", Name of bulk transfer

          
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

          
"type": "null", Configure schema name

          
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

        }
      ]
    },
    : {
Configure an object ListPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"object-list-name": "string", Name of the object List
          : {
Configure an object ListPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"oid": "string" Object name or OID 

              }
            ]
          },
          
"type": "null" Configure schema name

        }
      ]
    },
    : {
Configure schema definitionPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"schema-name": "string", The name of the schema
          : {
Instance of the schemaPUTPOSTDELETEGET
            
"end": "string", End Instance OID for repetition

            
"sub-interface": "boolean", Include all the subinterface

            
"start": "string", Start Instance OID for repetition

            
"max": "integer", Max value of Instance repetition

            
"instance": "string", Instance of the schema

            
"type": "string" Configure schema name

          },
          
"type": "null", Configure schema name

          
"schema-object-list": "string", Name of an object List

          
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

        }
      ]
    }
  }
}

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure schema definitionPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string", The name of the schema
        : {
Instance of the schemaPUTPOSTDELETEGET
          
"end": "string", End Instance OID for repetition

          
"sub-interface": "boolean", Include all the subinterface

          
"start": "string", Start Instance OID for repetition

          
"max": "integer", Max value of Instance repetition

          
"instance": "string", Instance of the schema

          
"type": "string" Configure schema name

        },
        
"type": "null", Configure schema name

        
"schema-object-list": "string", Name of an object List

        
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

a1_schemas_schema

schemasbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure schema definitionPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string", The name of the schema
        : {
Instance of the schemaPUTPOSTDELETEGET
          
"end": "string", End Instance OID for repetition

          
"sub-interface": "boolean", Include all the subinterface

          
"start": "string", Start Instance OID for repetition

          
"max": "integer", Max value of Instance repetition

          
"instance": "string", Instance of the schema

          
"type": "string" Configure schema name

        },
        
"type": "null", Configure schema name

        
"schema-object-list": "string", Name of an object List

        
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

200 OK
a1_schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure schema definitionPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string", The name of the schema
        : {
Instance of the schemaPUTPOSTDELETEGET
          
"end": "string", End Instance OID for repetition

          
"sub-interface": "boolean", Include all the subinterface

          
"start": "string", Start Instance OID for repetition

          
"max": "integer", Max value of Instance repetition

          
"instance": "string", Instance of the schema

          
"type": "string" Configure schema name

        },
        
"type": "null", Configure schema name

        
"schema-object-list": "string", Name of an object List

        
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

      }
    ]
  }
}

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string", The name of the schema
      : {
Instance of the schemaPUTPOSTDELETEGET
        
"end": "string", End Instance OID for repetition

        
"sub-interface": "boolean", Include all the subinterface

        
"start": "string", Start Instance OID for repetition

        
"max": "integer", Max value of Instance repetition

        
"instance": "string", Instance of the schema

        
"type": "string" Configure schema name

      },
      
"type": "null", Configure schema name

      
"schema-object-list": "string", Name of an object List

      
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

a1_schema_schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string", The name of the schema
      : {
Instance of the schemaPUTPOSTDELETEGET
        
"end": "string", End Instance OID for repetition

        
"sub-interface": "boolean", Include all the subinterface

        
"start": "string", Start Instance OID for repetition

        
"max": "integer", Max value of Instance repetition

        
"instance": "string", Instance of the schema

        
"type": "string" Configure schema name

      },
      
"type": "null", Configure schema name

      
"schema-object-list": "string", Name of an object List

      
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK
a1_schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string", The name of the schema
      : {
Instance of the schemaPUTPOSTDELETEGET
        
"end": "string", End Instance OID for repetition

        
"sub-interface": "boolean", Include all the subinterface

        
"start": "string", Start Instance OID for repetition

        
"max": "integer", Max value of Instance repetition

        
"instance": "string", Instance of the schema

        
"type": "string" Configure schema name

      },
      
"type": "null", Configure schema name

      
"schema-object-list": "string", Name of an object List

      
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"

    }
  ]
}

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : {
Instance of the schemaPUTPOSTDELETEGET
    
"end": "string", End Instance OID for repetition

    
"sub-interface": "boolean", Include all the subinterface

    
"start": "string", Start Instance OID for repetition

    
"max": "integer", Max value of Instance repetition

    
"instance": "string", Instance of the schema

    
"type": "string" Type of the instance

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

a1_instance_schema

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : {
Instance of the schemaPUTPOSTDELETEGET
    
"end": "string", End Instance OID for repetition

    
"sub-interface": "boolean", Include all the subinterface

    
"start": "string", Start Instance OID for repetition

    
"max": "integer", Max value of Instance repetition

    
"instance": "string", Instance of the schema

    
"type": "string" Type of the instance

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK
a1_instance_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Instance of the schemaPUTPOSTDELETEGET
    
"end": "string", End Instance OID for repetition

    
"sub-interface": "boolean", Include all the subinterface

    
"start": "string", Start Instance OID for repetition

    
"max": "integer", Max value of Instance repetition

    
"instance": "string", Instance of the schema

    
"type": "string" Type of the instance

  }
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

a1_objects_schema

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK
a1_objects_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Configure an object ListPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"oid": "string" Object name or OID 

      }
    ]
  }
}

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

a1_object_schema

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK
a1_object_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"oid": "string" Object name or OID 

    }
  ]
}

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
        : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"schema-name": "string" Schema that contains objects to be\ncollected

            }
          ]
        },
        
"format": "string", Format of the bulk data file

        
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

        
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

        
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

        
"enable": "null", Start Data Collection for this Configuration

        
"transfer-name": "string", Name of bulk transfer

        
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

        
"type": "null", Configure transfer list name

        
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

a1_transfers_schema

transfersbody object

Request Content-Types: application/json
Request Example
{
  : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
        : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"schema-name": "string" Schema that contains objects to be\ncollected

            }
          ]
        },
        
"format": "string", Format of the bulk data file

        
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

        
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

        
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

        
"enable": "null", Start Data Collection for this Configuration

        
"transfer-name": "string", Name of bulk transfer

        
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

        
"type": "null", Configure transfer list name

        
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

200 OK
a1_transfers_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Periodicity for the transfer of bulk data in\nminutesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
        : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"schema-name": "string" Schema that contains objects to be\ncollected

            }
          ]
        },
        
"format": "string", Format of the bulk data file

        
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

        
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

        
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

        
"enable": "null", Start Data Collection for this Configuration

        
"transfer-name": "string", Name of bulk transfer

        
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

        
"type": "null", Configure transfer list name

        
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

      }
    ]
  }
}

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
      : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"schema-name": "string" Schema that contains objects to be\ncollected

          }
        ]
      },
      
"format": "string", Format of the bulk data file

      
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

      
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

      
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

      
"enable": "null", Start Data Collection for this Configuration

      
"transfer-name": "string", Name of bulk transfer

      
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

      
"type": "null", Configure transfer list name

      
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

a1_transfer_schema

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
      : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"schema-name": "string" Schema that contains objects to be\ncollected

          }
        ]
      },
      
"format": "string", Format of the bulk data file

      
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

      
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

      
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

      
"enable": "null", Start Data Collection for this Configuration

      
"transfer-name": "string", Name of bulk transfer

      
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

      
"type": "null", Configure transfer list name

      
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
default: "1"
      : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"schema-name": "string" Schema that contains objects to be\ncollected

          }
        ]
      },
      
"format": "string", Format of the bulk data file

      
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
default: "240"

      
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer

      
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"

      
"enable": "null", Start Data Collection for this Configuration

      
"transfer-name": "string", Name of bulk transfer

      
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"

      
"type": "null", Configure transfer list name

      
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer

    }
  ]
}

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string" Schema that contains objects to be\ncollected

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

a1_transfer-schemas_schema

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{
  : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string" Schema that contains objects to be\ncollected

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK
a1_transfer-schemas_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Schema that contains objects to be collectedPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"schema-name": "string" Schema that contains objects to be\ncollected

      }
    ]
  }
}

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string" Schema that contains objects to be\ncollected

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

a1_transfer-schema_schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string" Schema that contains objects to be\ncollected

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK
a1_transfer-schema_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"schema-name": "string" Schema that contains objects to be\ncollected

    }
  ]
}

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted community mapPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

a1_default-community-maps_schema

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{
  : {
Container class to hold unencrpted community mapPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

200 OK
a1_default-community-maps_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class to hold unencrpted community mapPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"security": "string", SNMP Security Name 

        
"community-name": "string", SNMP community map

        
"context": "string", SNMP Context Name 

        
"target-list": "string" target list name 

      }
    ]
  }
}

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

a1_default-community-map_schema

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK
a1_default-community-map_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"security": "string", SNMP Security Name 

      
"community-name": "string", SNMP community map

      
"context": "string", SNMP Context Name 

      
"target-list": "string" target list name 

    }
  ]
}

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  : {
Set overload control params for handling\nincoming messagesPUTPOSTDELETEGET
    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"

    
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

a1_overload-control_schema

overload-controlbody object

Request Content-Types: application/json
Request Example
{
  : {
Set overload control params for handling\nincoming messagesPUTPOSTDELETEGET
    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"

    
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

200 OK
a1_overload-control_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Set overload control params for handling\nincoming messagesPUTPOSTDELETEGET
    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"

    
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"

  }
}

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP timeoutsPUTPOSTDELETEGET
    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"

    
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"

    
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"

    
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

a1_timeouts_schema

timeoutsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP timeoutsPUTPOSTDELETEGET
    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"

    
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"

    
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"

    
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

200 OK
a1_timeouts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP timeoutsPUTPOSTDELETEGET
    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"

    
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"

    
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"

    
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"

  }
}

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a user who can access the SNMP enginePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"v6acl-type": "string", Access-list type

        
"group-name": "string", Group to which the user belongs

        
"v6-access-list": "string", Ipv6 Access-list name

        
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

        
"owner": "string", The system access either SDROwner or\nSystemOwner

        
"v4acl-type": "string", Access-list type

        
"privacy-password": "string", The privacy password

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string", UDP port number

        
"user-name": "string", Name of the user

        
"algorithm": "string", The algorithm used md5 or sha

        
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

        
"authentication-password": "string", The authentication password

        
"version": "string", SNMP version to be used. v1,v2c or v3

        
"v4-access-list": "string", Ipv4 Access-list name

        
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

a1_users_schema

usersbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a user who can access the SNMP enginePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"v6acl-type": "string", Access-list type

        
"group-name": "string", Group to which the user belongs

        
"v6-access-list": "string", Ipv6 Access-list name

        
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

        
"owner": "string", The system access either SDROwner or\nSystemOwner

        
"v4acl-type": "string", Access-list type

        
"privacy-password": "string", The privacy password

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string", UDP port number

        
"user-name": "string", Name of the user

        
"algorithm": "string", The algorithm used md5 or sha

        
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

        
"authentication-password": "string", The authentication password

        
"version": "string", SNMP version to be used. v1,v2c or v3

        
"v4-access-list": "string", Ipv4 Access-list name

        
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

200 OK
a1_users_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Define a user who can access the SNMP enginePUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"v6acl-type": "string", Access-list type

        
"group-name": "string", Group to which the user belongs

        
"v6-access-list": "string", Ipv6 Access-list name

        
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

        
"owner": "string", The system access either SDROwner or\nSystemOwner

        
"v4acl-type": "string", Access-list type

        
"privacy-password": "string", The privacy password

        
"remote-address": "string", IP address of remote SNMP entity

        
"port": "string", UDP port number

        
"user-name": "string", Name of the user

        
"algorithm": "string", The algorithm used md5 or sha

        
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

        
"authentication-password": "string", The authentication password

        
"version": "string", SNMP version to be used. v1,v2c or v3

        
"v4-access-list": "string", Ipv4 Access-list name

        
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

      }
    ]
  }
}

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"v6acl-type": "string", Access-list type

      
"group-name": "string", Group to which the user belongs

      
"v6-access-list": "string", Ipv6 Access-list name

      
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

      
"owner": "string", The system access either SDROwner or\nSystemOwner

      
"v4acl-type": "string", Access-list type

      
"privacy-password": "string", The privacy password

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string", UDP port number

      
"user-name": "string", Name of the user

      
"algorithm": "string", The algorithm used md5 or sha

      
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

      
"authentication-password": "string", The authentication password

      
"version": "string", SNMP version to be used. v1,v2c or v3

      
"v4-access-list": "string", Ipv4 Access-list name

      
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

a1_user_schema

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"v6acl-type": "string", Access-list type

      
"group-name": "string", Group to which the user belongs

      
"v6-access-list": "string", Ipv6 Access-list name

      
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

      
"owner": "string", The system access either SDROwner or\nSystemOwner

      
"v4acl-type": "string", Access-list type

      
"privacy-password": "string", The privacy password

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string", UDP port number

      
"user-name": "string", Name of the user

      
"algorithm": "string", The algorithm used md5 or sha

      
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

      
"authentication-password": "string", The authentication password

      
"version": "string", SNMP version to be used. v1,v2c or v3

      
"v4-access-list": "string", Ipv4 Access-list name

      
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

200 OK
a1_user_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"v6acl-type": "string", Access-list type

      
"group-name": "string", Group to which the user belongs

      
"v6-access-list": "string", Ipv6 Access-list name

      
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des

      
"owner": "string", The system access either SDROwner or\nSystemOwner

      
"v4acl-type": "string", Access-list type

      
"privacy-password": "string", The privacy password

      
"remote-address": "string", IP address of remote SNMP entity

      
"port": "string", UDP port number

      
"user-name": "string", Name of the user

      
"algorithm": "string", The algorithm used md5 or sha

      
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3

      
"authentication-password": "string", The authentication password

      
"version": "string", SNMP version to be used. v1,v2c or v3

      
"v4-access-list": "string", Ipv4 Access-list name

      
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3

    }
  ]
}

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP VRF configuration commandsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
List of Context NamesPUTPOSTDELETEGET
          : [
SNMP context feature typePUTPOSTDELETEGET
            {
              
"context-name": "string" Context Name

            }
          ]
        },
        : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
                : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                },
                : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                }
              },
              
"ip-address": "string", IP address of SNMP notification host
              : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            }
          ]
        },
        
"name": "string", VRF name
        : {
List of context namesPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"context-mapping-name": "string", Context mapping name

              
"vrf-name": "string", VRF name associated with the context

              
"topology-name": "string", Topology name associated with the context

              
"context": "string", SNMP context feature type

              
"instance-name": "string" OSPF protocol instance

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

a1_vrfs_schema

vrfsbody object

Request Content-Types: application/json
Request Example
{
  : {
SNMP VRF configuration commandsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
List of Context NamesPUTPOSTDELETEGET
          : [
SNMP context feature typePUTPOSTDELETEGET
            {
              
"context-name": "string" Context Name

            }
          ]
        },
        : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
                : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                },
                : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                }
              },
              
"ip-address": "string", IP address of SNMP notification host
              : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            }
          ]
        },
        
"name": "string", VRF name
        : {
List of context namesPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"context-mapping-name": "string", Context mapping name

              
"vrf-name": "string", VRF name associated with the context

              
"topology-name": "string", Topology name associated with the context

              
"context": "string", SNMP context feature type

              
"instance-name": "string" OSPF protocol instance

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

200 OK
a1_vrfs_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
SNMP VRF configuration commandsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
List of Context NamesPUTPOSTDELETEGET
          : [
SNMP context feature typePUTPOSTDELETEGET
            {
              
"context-name": "string" Context Name

            }
          ]
        },
        : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
                : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                },
                : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                  : [
No descriptionPUTPOSTDELETEGET
                    {
                      
"port": "string", UDP port number

                      
"version": "string", SNMP Version to be used v1/v2c/v3

                      
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                      
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                      
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                      
"security-level": "string", Security level to be used noauth/auth/priv

                      
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                    }
                  ]
                }
              },
              
"ip-address": "string", IP address of SNMP notification host
              : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            }
          ]
        },
        
"name": "string", VRF name
        : {
List of context namesPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"context-mapping-name": "string", Context mapping name

              
"vrf-name": "string", VRF name associated with the context

              
"topology-name": "string", Topology name associated with the context

              
"context": "string", SNMP context feature type

              
"instance-name": "string" OSPF protocol instance

            }
          ]
        }
      }
    ]
  }
}

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
List of Context NamesPUTPOSTDELETEGET
        : [
SNMP context feature typePUTPOSTDELETEGET
          {
            
"context-name": "string" Context Name

          }
        ]
      },
      : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            },
            : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
              : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            },
            
"ip-address": "string", IP address of SNMP notification host
            : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            }
          }
        ]
      },
      
"name": "string", VRF name
      : {
List of context namesPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"context-mapping-name": "string", Context mapping name

            
"vrf-name": "string", VRF name associated with the context

            
"topology-name": "string", Topology name associated with the context

            
"context": "string", SNMP context feature type

            
"instance-name": "string" OSPF protocol instance

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

a1_vrf_schema

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
List of Context NamesPUTPOSTDELETEGET
        : [
SNMP context feature typePUTPOSTDELETEGET
          {
            
"context-name": "string" Context Name

          }
        ]
      },
      : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            },
            : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
              : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            },
            
"ip-address": "string", IP address of SNMP notification host
            : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            }
          }
        ]
      },
      
"name": "string", VRF name
      : {
List of context namesPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"context-mapping-name": "string", Context mapping name

            
"vrf-name": "string", VRF name associated with the context

            
"topology-name": "string", Topology name associated with the context

            
"context": "string", SNMP context feature type

            
"instance-name": "string" OSPF protocol instance

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK
a1_vrf_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
List of Context NamesPUTPOSTDELETEGET
        : [
SNMP context feature typePUTPOSTDELETEGET
          {
            
"context-name": "string" Context Name

          }
        ]
      },
      : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            },
            : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
              : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              },
              : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
                : [
No descriptionPUTPOSTDELETEGET
                  {
                    
"port": "string", UDP port number

                    
"version": "string", SNMP Version to be used v1/v2c/v3

                    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                    
"security-level": "string", Security level to be used noauth/auth/priv

                    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                  }
                ]
              }
            },
            
"ip-address": "string", IP address of SNMP notification host
            : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
              : [
No descriptionPUTPOSTDELETEGET
                {
                  
"port": "string", UDP port number

                  
"version": "string", SNMP Version to be used v1/v2c/v3

                  
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                  
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                  
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                  
"security-level": "string", Security level to be used noauth/auth/priv

                  
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

                }
              ]
            }
          }
        ]
      },
      
"name": "string", VRF name
      : {
List of context namesPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"context-mapping-name": "string", Context mapping name

            
"vrf-name": "string", VRF name associated with the context

            
"topology-name": "string", Topology name associated with the context

            
"context": "string", SNMP context feature type

            
"instance-name": "string" OSPF protocol instance

          }
        ]
      }
    }
  ]
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a User Security Model groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string", Name of the group

        
"write-view": "string", write view name

        
"snmp-version": "string", snmp version

        
"context-name": "string", Context name

        
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"read-view": "string", read view name

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string", Ipv4 Access-list name

        
"notify-view": "string" notify view name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

a1_groups_schema

groupsbody object

Request Content-Types: application/json
Request Example
{
  : {
Define a User Security Model groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string", Name of the group

        
"write-view": "string", write view name

        
"snmp-version": "string", snmp version

        
"context-name": "string", Context name

        
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"read-view": "string", read view name

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string", Ipv4 Access-list name

        
"notify-view": "string" notify view name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

200 OK
a1_groups_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Define a User Security Model groupPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"name": "string", Name of the group

        
"write-view": "string", write view name

        
"snmp-version": "string", snmp version

        
"context-name": "string", Context name

        
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

        
"v6acl-type": "string", Access-list type

        
"v6-access-list": "string", Ipv6 Access-list name

        
"read-view": "string", read view name

        
"v4acl-type": "string", Access-list type

        
"v4-access-list": "string", Ipv4 Access-list name

        
"notify-view": "string" notify view name

      }
    ]
  }
}

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string", Name of the group

      
"write-view": "string", write view name

      
"snmp-version": "string", snmp version

      
"context-name": "string", Context name

      
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

      
"v6acl-type": "string", Access-list type

      
"v6-access-list": "string", Ipv6 Access-list name

      
"read-view": "string", read view name

      
"v4acl-type": "string", Access-list type

      
"v4-access-list": "string", Ipv4 Access-list name

      
"notify-view": "string" notify view name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

a1_group_schema

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string", Name of the group

      
"write-view": "string", write view name

      
"snmp-version": "string", snmp version

      
"context-name": "string", Context name

      
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

      
"v6acl-type": "string", Access-list type

      
"v6-access-list": "string", Ipv6 Access-list name

      
"read-view": "string", read view name

      
"v4acl-type": "string", Access-list type

      
"v4-access-list": "string", Ipv4 Access-list name

      
"notify-view": "string" notify view name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

200 OK
a1_group_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"name": "string", Name of the group

      
"write-view": "string", write view name

      
"snmp-version": "string", snmp version

      
"context-name": "string", Context name

      
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3

      
"v6acl-type": "string", Access-list type

      
"v6-access-list": "string", Ipv6 Access-list name

      
"read-view": "string", read view name

      
"v4acl-type": "string", Access-list type

      
"v4-access-list": "string", Ipv4 Access-list name

      
"notify-view": "string" notify view name

    }
  ]
}

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

a1_trap-hosts_schema

trap-hostsbody object

Request Content-Types: application/json
Request Example
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

200 OK
a1_trap-hosts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Specify hosts to receive SNMP notificationsPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
          : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          },
          : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
            : [
No descriptionPUTPOSTDELETEGET
              {
                
"port": "string", UDP port number

                
"version": "string", SNMP Version to be used v1/v2c/v3

                
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

                
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

                
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

                
"security-level": "string", Security level to be used noauth/auth/priv

                
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

              }
            ]
          }
        },
        
"ip-address": "string", IP address of SNMP notification host
        : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      }
    ]
  }
}

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

a1_trap-host_schema

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK
a1_trap-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      },
      : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
        : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        },
        : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
          : [
No descriptionPUTPOSTDELETEGET
            {
              
"port": "string", UDP port number

              
"version": "string", SNMP Version to be used v1/v2c/v3

              
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

              
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

              
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

              
"security-level": "string", Security level to be used noauth/auth/priv

              
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

            }
          ]
        }
      },
      
"ip-address": "string", IP address of SNMP notification host
      : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
        : [
No descriptionPUTPOSTDELETEGET
          {
            
"port": "string", UDP port number

            
"version": "string", SNMP Version to be used v1/v2c/v3

            
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

            
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

            
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

            
"security-level": "string", Security level to be used noauth/auth/priv

            
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

          }
        ]
      }
    }
  ]
}

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

a1_encrypted-user-communities_schema

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a trap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

a1_encrypted-user-community_schema

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

a1_inform-host_schema

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-host_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining notification type\nfor a Inform hostPUTPOSTDELETEGET
    : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    },
    : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
      : [
No descriptionPUTPOSTDELETEGET
        {
          
"port": "string", UDP port number

          
"version": "string", SNMP Version to be used v2c/v3

          
"community-name": "string", SNMPv2c community string or SNMPv3 user

          
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

          
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

          
"security-level": "string", Security level to be used noauth/auth/priv

          
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

        }
      ]
    }
  }
}

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

a1_inform-user-communities_schema

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for\na inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

a1_inform-user-community_schema

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

a1_inform-encrypted-user-communities_schema

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_inform-encrypted-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining Clear/encrypt\ncommunities for a inform hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v2c/v3

        
"community-name": "string", SNMPv2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

a1_inform-encrypted-user-community_schema

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_inform-encrypted-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v2c/v3

    
"community-name": "string", SNMPv2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

a1_default-user-communities_schema

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK
a1_default-user-communities_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
Container class for defining communities for a\ntrap hostPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"port": "string", UDP port number

        
"version": "string", SNMP Version to be used v1/v2c/v3

        
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

        
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

        
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

        
"security-level": "string", Security level to be used noauth/auth/priv

        
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

      }
    ]
  }
}

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

a1_default-user-community_schema

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK
a1_default-user-community_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
No descriptionPUTPOSTDELETEGET
    
"port": "string", UDP port number

    
"version": "string", SNMP Version to be used v1/v2c/v3

    
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user

    
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps

    
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0

    
"security-level": "string", Security level to be used noauth/auth/priv

    
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used

  }
}

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

a1_contexts_schema

contextsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

200 OK
a1_contexts_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of Context NamesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-name": "string" Context Name

      }
    ]
  }
}

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

a1_context_schema

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

200 OK
a1_context_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-name": "string" Context Name

    }
  ]
}

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

a1_context-mappings_schema

context-mappingsbody object

Request Content-Types: application/json
Request Example
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

200 OK
a1_context-mappings_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : {
List of context namesPUTPOSTDELETEGET
    : [
No descriptionPUTPOSTDELETEGET
      {
        
"context-mapping-name": "string", Context mapping name

        
"vrf-name": "string", VRF name associated with the context

        
"topology-name": "string", Topology name associated with the context

        
"context": "string", SNMP context feature type

        
"instance-name": "string" OSPF protocol instance

      }
    ]
  }
}

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

a1_context-mapping_schema

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK
a1_context-mapping_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{
  : [
No descriptionPUTPOSTDELETEGET
    {
      
"context-mapping-name": "string", Context mapping name

      
"vrf-name": "string", VRF name associated with the context

      
"topology-name": "string", Topology name associated with the context

      
"context": "string", SNMP context feature type

      
"instance-name": "string" OSPF protocol instance

    }
  ]
}

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

a1_mib_schema

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK
a1_mib_schema

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK) 
{